diff options
| author | Gordon Sim <gsim@apache.org> | 2007-06-27 12:36:49 +0000 |
|---|---|---|
| committer | Gordon Sim <gsim@apache.org> | 2007-06-27 12:36:49 +0000 |
| commit | 4add83a2d2482a51f447ca71d2385ae19ea173fa (patch) | |
| tree | eea32ac04664bc909d67de9c4a3f0d9e9fb54851 | |
| parent | af6a722927f83e72400312471a758f7cdf9acbc3 (diff) | |
| download | qpid-python-4add83a2d2482a51f447ca71d2385ae19ea173fa.tar.gz | |
Added previews of the exchange- and binding- query methods that have been agreed for 0-10.
git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/trunk/qpid@551143 13f79535-47bb-0310-9956-ffa450edef68
| -rw-r--r-- | specs/amqp-dtx-preview.0-9.xml | 165 |
1 files changed, 165 insertions, 0 deletions
diff --git a/specs/amqp-dtx-preview.0-9.xml b/specs/amqp-dtx-preview.0-9.xml index f1c10f609c..defbdd067e 100644 --- a/specs/amqp-dtx-preview.0-9.xml +++ b/specs/amqp-dtx-preview.0-9.xml @@ -875,4 +875,169 @@ </method> </class> +<!-- Some other 0-10 previews: --> + + <class name="binding" handler="binding" index="130" + label="provides the ability to query bindings"> + <doc> + This is a utility class for querying and exchange about its bindings to queues. + </doc> + + <chassis name="server" implement="MUST" /> + <chassis name="client" implement="MAY" /> + + <method name="query" synchronous="1" index="10" + label="request information about bindings to an exchange"> + <doc> + This method is used to request information on the bindings to a particular exchange. That + information is conveyed in a query-ok method. + </doc> + + <chassis name="server" implement="MUST" /> + <response name="query-ok" /> + + <field name="ticket" domain="access-ticket"> + <rule name="validity" on-failure="access-refused"> + <doc> + A valid ticket should be provided. + </doc> + </rule> + </field> + + <field name="exchange" domain="shortstr" label="the exchange name"> + <doc> + The name of the exchange for which binding information is being requested. If not + specified explicitly the default exchange is implied. + </doc> + </field> + + <field name="queue" domain="shortstr" label="a queue name"> + <doc> + If populated then determine whether the given queue is bound to the exchange. + </doc> + </field> + + <field name="routing-key" domain="shortstr" label="a routing-key"> + <doc> + If populated defines the routing key of the binding of interest, if not populated the + request will ignore the routing key on bindings when searching for a match. + </doc> + </field> + + <field name="arguments" domain="table" label="a set of binding arguments"> + <doc> + If populated defines the arguments of the binding of interest if not populated the request + will ignore the arguments on bindings when searching for a match + </doc> + </field> + </method> + + <method name="query-ok" synchronous="1" index="11" + label="returns information about bindings to exchange"> + <doc> + This method is used in response to a query and conveys information on the bindings to a + particular exchange. + </doc> + + <chassis name="client" implement="MUST" /> + + <field name="exchange-not-found" domain="bit" label="indicate an unknown exchange"> + <doc> + If set, the exchange for which information was requested is not known. + </doc> + </field> + + <field name="queue-not-found" domain="bit" label="indicate an unknown queue"> + <doc> + If set, the queue specified is not known. + </doc> + </field> + + <field name="queue-not-matched" domain="bit" label="indicate no matching queue"> + <doc> + A bit which if set indicates that no binding was found from the specified exchange to the + specified queue. + </doc> + </field> + + <field name="key-not-matched" domain="bit" label="indicate no matching routing key"> + <doc> + A bit which if set indicates that no binding was found from the specified exchange with + the specified routing key. + </doc> + </field> + + <field name="args-not-matched" domain="bit" label="indicate no matching args"> + <doc> + A bit which if set indicates that no binding was found from the specified exchange with + the specified arguments. + </doc> + </field> + </method> + </class> + + + + <class name="exchange" handler="channel" index="40" label="work with exchanges"> + <method name="query" synchronous="1" index="30" label="request information about an exchange"> + <doc> + This method is used to request information on a particular exchange. That information is + conveyed by an query-ok method. + </doc> + + <chassis name="server" implement="MUST" /> + <response name="query-ok" /> + + <field name="ticket" domain="access-ticket"> + <rule name="validity" on-failure="access-refused"> + <doc> + A valid ticket should be provided. + </doc> + </rule> + </field> + + <field name="name" domain="shortstr" label="the exchange name"> + <doc> + The name of the exchange for which information is requested. If not specified explicitly + the default exchange is implied. + </doc> + </field> + </method> + + <method name="query-ok" synchronous="1" index="31" label="return exchange information"> + <doc> + This method is used in response to a query request and conveys information on a particular + exchange. + </doc> + + <chassis name="client" implement="MUST" /> + + <field name="type" domain="shortstr" label="indicate the exchange type"> + <doc> + The type of the exchange. Will be empty if the exchange is not found. + </doc> + </field> + + <field name="durable" domain="bit" label="indicate the durability"> + <doc> + The durability of the exchange, i.e. if set the exchange is durable. Will not be set if + the exchange is not found. + </doc> + </field> + + <field name="not-found" domain="bit" label="indicate an unknown exchange"> + <doc> + If set, the exchange for which information was requested is not known. + </doc> + </field> + + <field name="arguments" domain="table" label="other unspecified exchange properties"> + <doc> + A set of properties of the exchange whose syntax and semantics depends on the server + implementation. Will be empty if the exchange is not found. + </doc> + </field> + </method> + </class> + </amqp> |
