Merge pull request #15315 from DaanDeMeyer/deprecate-sd-bus-priority

sd-bus: Deprecate priority functions
This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2020-04-03 18:07:54 +02:00 committed by GitHub
commit 1b87e27999
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 15 additions and 42 deletions

View file

@ -291,9 +291,7 @@ manpages = [
'sd_bus_message_get_interface', 'sd_bus_message_get_interface',
'sd_bus_message_get_member', 'sd_bus_message_get_member',
'sd_bus_message_get_path', 'sd_bus_message_get_path',
'sd_bus_message_get_priority',
'sd_bus_message_get_sender', 'sd_bus_message_get_sender',
'sd_bus_message_set_priority',
'sd_bus_message_set_sender'], 'sd_bus_message_set_sender'],
''], ''],
['sd_bus_message_set_expect_reply', ['sd_bus_message_set_expect_reply',

View file

@ -70,7 +70,6 @@
<citerefentry><refentrytitle>sd_bus_message_dump</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_message_dump</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_message_get_cookie</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_message_get_cookie</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_message_get_monotonic_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_message_get_monotonic_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_message_get_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_message_get_sender</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_message_get_sender</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_message_get_signature</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_message_get_signature</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_message_get_type</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_message_get_type</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
@ -84,7 +83,6 @@
<citerefentry><refentrytitle>sd_bus_message_rewind</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_message_rewind</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_message_seal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_message_seal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_message_set_destination</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_message_set_destination</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_message_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_message_set_sender</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_message_set_sender</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_message_set_expect_reply</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_message_set_expect_reply</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_message_skip</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_message_skip</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

View file

@ -19,8 +19,6 @@
<refname>sd_bus_message_get_path</refname> <refname>sd_bus_message_get_path</refname>
<refname>sd_bus_message_get_interface</refname> <refname>sd_bus_message_get_interface</refname>
<refname>sd_bus_message_get_member</refname> <refname>sd_bus_message_get_member</refname>
<refname>sd_bus_message_set_priority</refname>
<refname>sd_bus_message_get_priority</refname>
<refname>sd_bus_message_set_sender</refname> <refname>sd_bus_message_set_sender</refname>
<refname>sd_bus_message_get_sender</refname> <refname>sd_bus_message_get_sender</refname>
@ -57,18 +55,6 @@
<paramdef>sd_bus_message *<parameter>message</parameter></paramdef> <paramdef>sd_bus_message *<parameter>message</parameter></paramdef>
</funcprototype> </funcprototype>
<funcprototype>
<funcdef>int <function>sd_bus_message_set_priority</function></funcdef>
<paramdef>sd_bus_message *<parameter>message</parameter></paramdef>
<paramdef>int64_t <parameter>priority</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>sd_bus_message_get_priority</function></funcdef>
<paramdef>sd_bus_message *<parameter>message</parameter></paramdef>
<paramdef>int64_t *<parameter>priority</parameter></paramdef>
</funcprototype>
<funcprototype> <funcprototype>
<funcdef>int <function>sd_bus_message_set_sender</function></funcdef> <funcdef>int <function>sd_bus_message_set_sender</function></funcdef>
<paramdef>sd_bus_message *<parameter>message</parameter></paramdef> <paramdef>sd_bus_message *<parameter>message</parameter></paramdef>
@ -100,10 +86,6 @@
<citerefentry><refentrytitle>sd_bus_message_set_destination</refentrytitle><manvolnum>3</manvolnum></citerefentry> <citerefentry><refentrytitle>sd_bus_message_set_destination</refentrytitle><manvolnum>3</manvolnum></citerefentry>
for more discussion of those values.</para> for more discussion of those values.</para>
<para><function>sd_bus_message_set_priority()</function> and
<function>sd_bus_message_get_priority()</function> modify and query a message's priority
respectively. sd-bus currently doesn't make use of a message's priority.</para>
<para><function>sd_bus_message_set_sender()</function> sets the sender service name for the specified bus message <para><function>sd_bus_message_set_sender()</function> sets the sender service name for the specified bus message
object. The specified name must be a valid unique or well-known service name. This function is useful only for object. The specified name must be a valid unique or well-known service name. This function is useful only for
messages to send on direct connections as for connections to bus brokers the broker will fill in the destination messages to send on direct connections as for connections to bus brokers the broker will fill in the destination
@ -139,9 +121,8 @@
<varlistentry> <varlistentry>
<term><constant>-EPERM</constant></term> <term><constant>-EPERM</constant></term>
<listitem><para>For <function>sd_bus_message_set_destination()</function>, <listitem><para>For <function>sd_bus_message_set_destination()</function> and
<function>sd_bus_message_set_sender()</function> and <function>sd_bus_message_set_sender()</function>, the message is already sealed.</para>
<function>sd_bus_message_set_priority()</function>, the message is already sealed.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>

View file

@ -1833,7 +1833,7 @@ static int dispatch_wqueue(sd_bus *bus) {
return ret; return ret;
} }
static int bus_read_message(sd_bus *bus, bool hint_priority, int64_t priority) { static int bus_read_message(sd_bus *bus) {
assert(bus); assert(bus);
return bus_socket_read_message(bus); return bus_socket_read_message(bus);
@ -1860,17 +1860,13 @@ static void rqueue_drop_one(sd_bus *bus, size_t i) {
bus->rqueue_size--; bus->rqueue_size--;
} }
static int dispatch_rqueue(sd_bus *bus, bool hint_priority, int64_t priority, sd_bus_message **m) { static int dispatch_rqueue(sd_bus *bus, sd_bus_message **m) {
int r, ret = 0; int r, ret = 0;
assert(bus); assert(bus);
assert(m); assert(m);
assert(IN_SET(bus->state, BUS_RUNNING, BUS_HELLO)); assert(IN_SET(bus->state, BUS_RUNNING, BUS_HELLO));
/* Note that the priority logic is only available on kdbus,
* where the rqueue is unused. We check the rqueue here
* anyway, because it's simple... */
for (;;) { for (;;) {
if (bus->rqueue_size > 0) { if (bus->rqueue_size > 0) {
/* Dispatch a queued message */ /* Dispatch a queued message */
@ -1880,7 +1876,7 @@ static int dispatch_rqueue(sd_bus *bus, bool hint_priority, int64_t priority, sd
} }
/* Try to read a new message */ /* Try to read a new message */
r = bus_read_message(bus, hint_priority, priority); r = bus_read_message(bus);
if (r < 0) if (r < 0)
return r; return r;
if (r == 0) { if (r == 0) {
@ -2237,7 +2233,7 @@ _public_ int sd_bus_call(
i++; i++;
} }
r = bus_read_message(bus, false, 0); r = bus_read_message(bus);
if (r < 0) { if (r < 0) {
if (ERRNO_IS_DISCONNECT(r)) { if (ERRNO_IS_DISCONNECT(r)) {
bus_enter_closing(bus); bus_enter_closing(bus);
@ -2776,7 +2772,7 @@ static int dispatch_track(sd_bus *bus) {
return 1; return 1;
} }
static int process_running(sd_bus *bus, bool hint_priority, int64_t priority, sd_bus_message **ret) { static int process_running(sd_bus *bus, sd_bus_message **ret) {
_cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL; _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL;
int r; int r;
@ -2795,7 +2791,7 @@ static int process_running(sd_bus *bus, bool hint_priority, int64_t priority, sd
if (r != 0) if (r != 0)
goto null_message; goto null_message;
r = dispatch_rqueue(bus, hint_priority, priority, &m); r = dispatch_rqueue(bus, &m);
if (r < 0) if (r < 0)
return r; return r;
if (!m) if (!m)
@ -2981,7 +2977,7 @@ finish:
return r; return r;
} }
static int bus_process_internal(sd_bus *bus, bool hint_priority, int64_t priority, sd_bus_message **ret) { static int bus_process_internal(sd_bus *bus, sd_bus_message **ret) {
int r; int r;
/* Returns 0 when we didn't do anything. This should cause the /* Returns 0 when we didn't do anything. This should cause the
@ -3021,7 +3017,7 @@ static int bus_process_internal(sd_bus *bus, bool hint_priority, int64_t priorit
case BUS_RUNNING: case BUS_RUNNING:
case BUS_HELLO: case BUS_HELLO:
r = process_running(bus, hint_priority, priority, ret); r = process_running(bus, ret);
if (r >= 0) if (r >= 0)
return r; return r;
@ -3048,11 +3044,11 @@ static int bus_process_internal(sd_bus *bus, bool hint_priority, int64_t priorit
} }
_public_ int sd_bus_process(sd_bus *bus, sd_bus_message **ret) { _public_ int sd_bus_process(sd_bus *bus, sd_bus_message **ret) {
return bus_process_internal(bus, false, 0, ret); return bus_process_internal(bus, ret);
} }
_public_ int sd_bus_process_priority(sd_bus *bus, int64_t priority, sd_bus_message **ret) { _public_ int sd_bus_process_priority(sd_bus *bus, int64_t priority, sd_bus_message **ret) {
return bus_process_internal(bus, true, priority, ret); return bus_process_internal(bus, ret);
} }
static int bus_poll(sd_bus *bus, bool need_more, uint64_t timeout_usec) { static int bus_poll(sd_bus *bus, bool need_more, uint64_t timeout_usec) {

View file

@ -204,7 +204,7 @@ int sd_bus_get_fd(sd_bus *bus);
int sd_bus_get_events(sd_bus *bus); int sd_bus_get_events(sd_bus *bus);
int sd_bus_get_timeout(sd_bus *bus, uint64_t *timeout_usec); int sd_bus_get_timeout(sd_bus *bus, uint64_t *timeout_usec);
int sd_bus_process(sd_bus *bus, sd_bus_message **r); int sd_bus_process(sd_bus *bus, sd_bus_message **r);
int sd_bus_process_priority(sd_bus *bus, int64_t max_priority, sd_bus_message **r); int sd_bus_process_priority(sd_bus *bus, int64_t max_priority, sd_bus_message **r) _sd_deprecated_; /* deprecated */
int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec); int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec);
int sd_bus_flush(sd_bus *bus); int sd_bus_flush(sd_bus *bus);
int sd_bus_enqueue_for_read(sd_bus *bus, sd_bus_message *m); int sd_bus_enqueue_for_read(sd_bus *bus, sd_bus_message *m);
@ -272,7 +272,7 @@ int sd_bus_message_seal(sd_bus_message *m, uint64_t cookie, uint64_t timeout_use
int sd_bus_message_get_type(sd_bus_message *m, uint8_t *type); int sd_bus_message_get_type(sd_bus_message *m, uint8_t *type);
int sd_bus_message_get_cookie(sd_bus_message *m, uint64_t *cookie); int sd_bus_message_get_cookie(sd_bus_message *m, uint64_t *cookie);
int sd_bus_message_get_reply_cookie(sd_bus_message *m, uint64_t *cookie); int sd_bus_message_get_reply_cookie(sd_bus_message *m, uint64_t *cookie);
int sd_bus_message_get_priority(sd_bus_message *m, int64_t *priority); int sd_bus_message_get_priority(sd_bus_message *m, int64_t *priority) _sd_deprecated_; /* deprecated */
int sd_bus_message_get_expect_reply(sd_bus_message *m); int sd_bus_message_get_expect_reply(sd_bus_message *m);
int sd_bus_message_get_auto_start(sd_bus_message *m); int sd_bus_message_get_auto_start(sd_bus_message *m);
@ -306,7 +306,7 @@ int sd_bus_message_set_allow_interactive_authorization(sd_bus_message *m, int b)
int sd_bus_message_set_destination(sd_bus_message *m, const char *destination); int sd_bus_message_set_destination(sd_bus_message *m, const char *destination);
int sd_bus_message_set_sender(sd_bus_message *m, const char *sender); int sd_bus_message_set_sender(sd_bus_message *m, const char *sender);
int sd_bus_message_set_priority(sd_bus_message *m, int64_t priority); int sd_bus_message_set_priority(sd_bus_message *m, int64_t priority) _sd_deprecated_; /* deprecated */
int sd_bus_message_append(sd_bus_message *m, const char *types, ...); int sd_bus_message_append(sd_bus_message *m, const char *types, ...);
int sd_bus_message_appendv(sd_bus_message *m, const char *types, va_list ap); int sd_bus_message_appendv(sd_bus_message *m, const char *types, va_list ap);