Modified: qpid/site/docs/releases/qpid-dispatch-trunk/api/group__compose.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-trunk/api/group__compose.html?rev=1653654&r1=1653653&r2=1653654&view=diff ============================================================================== --- qpid/site/docs/releases/qpid-dispatch-trunk/api/group__compose.html (original) +++ qpid/site/docs/releases/qpid-dispatch-trunk/api/group__compose.html Wed Jan 21 21:07:42 2015 @@ -4,7 +4,7 @@ -Qpid Dispatch Library API: Compose +Qpid Dispatch Library API: compose @@ -90,7 +90,7 @@ $(document).ready(function(){initNavTree
Functions
-
Compose
+
compose
@@ -263,7 +263,7 @@ Functions

Free the resources associated with a composed field.

Parameters
- +
Afield pointer returned by qd_compose.
fieldA field pointer returned by qd_compose.
Added: qpid/site/docs/releases/qpid-dispatch-trunk/api/group__connection.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-trunk/api/group__connection.html?rev=1653654&view=auto ============================================================================== --- qpid/site/docs/releases/qpid-dispatch-trunk/api/group__connection.html (added) +++ qpid/site/docs/releases/qpid-dispatch-trunk/api/group__connection.html Wed Jan 21 21:07:42 2015 @@ -0,0 +1,685 @@ + + + + + + +Qpid Dispatch Library API: connection + + + + + + + + + + + + + +
+
+ + + + + + + +
+
Qpid Dispatch Library API +  trunk +
+
+ + + + + + +
+
+
+ + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+ +
+
connection
+
+
+ + + + +

+Classes

struct  qd_server_config_t
 
+ + + + + + + + + + + +

+Typedefs

typedef struct qd_listener_t qd_listener_t
 
typedef struct qd_connector_t qd_connector_t
 
typedef struct qd_connection_t qd_connection_t
 
typedef struct qd_server_config_t qd_server_config_t
 
typedef int(* qd_conn_handler_cb_t )(void *handler_context, void *conn_context, qd_conn_event_t event, qd_connection_t *conn)
 
+ + + +

+Enumerations

enum  qd_conn_event_t { QD_CONN_EVENT_LISTENER_OPEN, +QD_CONN_EVENT_CONNECTOR_OPEN, +QD_CONN_EVENT_CLOSE, +QD_CONN_EVENT_PROCESS + }
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Functions

void qd_server_set_conn_handler (qd_dispatch_t *qd, qd_conn_handler_cb_t conn_handler, void *handler_context)
 
void qd_connection_set_context (qd_connection_t *conn, void *context)
 
void * qd_connection_get_context (qd_connection_t *conn)
 
void qd_connection_set_link_context (qd_connection_t *conn, void *context)
 
void * qd_connection_get_link_context (qd_connection_t *conn)
 
void qd_server_activate (qd_connection_t *conn)
 
pn_connection_t * qd_connection_pn (qd_connection_t *conn)
 
pn_collector_t * qd_connection_collector (qd_connection_t *conn)
 
const qd_server_config_tqd_connection_config (const qd_connection_t *conn)
 
qd_listener_tqd_server_listen (qd_dispatch_t *qd, const qd_server_config_t *config, void *context)
 
void qd_server_listener_free (qd_listener_t *li)
 
void qd_server_listener_close (qd_listener_t *li)
 
qd_connector_tqd_server_connect (qd_dispatch_t *qd, const qd_server_config_t *config, void *context)
 
void qd_server_connector_free (qd_connector_t *ct)
 
+

Detailed Description

+

Server AMQP Connection Handling

+

Handling listeners, connectors, connections and events.

+

Typedef Documentation

+ +
+
+ + + + +
typedef int(* qd_conn_handler_cb_t)(void *handler_context, void *conn_context, qd_conn_event_t event, qd_connection_t *conn)
+
+

Connection Event Handler

+

Callback invoked when processing is needed on a proton connection. This callback shall be invoked on one of the server's worker threads. The server guarantees that no two threads shall be allowed to process a single connection concurrently. The implementation of this handler may assume that it has exclusive access to the connection and its subservient components (sessions, links, deliveries, etc.).

+
Parameters
+ + + + + +
handler_contextThe handler context supplied in qd_server_set_conn_handler.
conn_contextThe handler context supplied in qd_server_{connect,listen}.
eventThe event/reason for the invocation of the handler.
connThe connection that requires processing by the handler.
+
+
+
Returns
A value greater than zero if the handler did any proton processing for the connection. If no work was done, zero is returned.
+ +
+
+ +
+
+ + + + +
typedef struct qd_connection_t qd_connection_t
+
+

Connection objects wrap Proton connection objects.

+ +
+
+ +
+
+ + + + +
typedef struct qd_connector_t qd_connector_t
+
+

Connector objects represent the desire to create and maintain an outgoing transport connection.

+ +
+
+ +
+
+ + + + +
typedef struct qd_listener_t qd_listener_t
+
+

Listener objects represent the desire to accept incoming transport connections.

+ +
+
+ +
+
+ + + + +
typedef struct qd_server_config_t qd_server_config_t
+
+

Configuration block for a connector or a listener.

+ +
+
+

Enumeration Type Documentation

+ +
+
+ + + + +
enum qd_conn_event_t
+
+

Event type for the connection callback.

+ + + + + +
Enumerator
QD_CONN_EVENT_LISTENER_OPEN  +

The connection just opened via a listener (inbound).

+
QD_CONN_EVENT_CONNECTOR_OPEN  +

The connection just opened via a connector (outbound).

+
QD_CONN_EVENT_CLOSE  +

The connection was closed at the transport level (not cleanly).

+
QD_CONN_EVENT_PROCESS  +

The connection requires processing.

+
+ +
+
+

Function Documentation

+ +
+
+ + + + + + + + +
pn_collector_t* qd_connection_collector (qd_connection_tconn)
+
+

Get the event collector for a connection.

+
Parameters
+ + +
connConnection object supplied in QD_CONN_EVENT_{LISTENER,CONNETOR}_OPEN
+
+
+
Returns
The pn_collector associated with the connection.
+ +
+
+ +
+
+ + + + + + + + +
const qd_server_config_t* qd_connection_config (const qd_connection_tconn)
+
+

Get the configuration that was used in the setup of this connection.

+
Parameters
+ + +
connConnection object supplied in QD_CONN_EVENT_{LISTENER,CONNETOR}_OPEN
+
+
+
Returns
A pointer to the server configuration used in the establishment of this connection.
+ +
+
+ +
+
+ + + + + + + + +
void* qd_connection_get_context (qd_connection_tconn)
+
+

Get the user context from a connection.

+
Parameters
+ + +
connConnection object supplied in QD_CONN_EVENT_{LISTENER,CONNETOR}_OPEN
+
+
+
Returns
The user context stored with the connection.
+ +
+
+ +
+
+ + + + + + + + +
void* qd_connection_get_link_context (qd_connection_tconn)
+
+

Get the link context from a connection.

+
Parameters
+ + +
connConnection object supplied in QD_CONN_EVENT_{LISTENER,CONNETOR}_OPEN
+
+
+
Returns
The link context stored with the connection.
+ +
+
+ +
+
+ + + + + + + + +
pn_connection_t* qd_connection_pn (qd_connection_tconn)
+
+

Get the wrapped proton-engine connection object.

+
Parameters
+ + +
connConnection object supplied in QD_CONN_EVENT_{LISTENER,CONNETOR}_OPEN
+
+
+
Returns
The proton connection object.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void qd_connection_set_context (qd_connection_tconn,
void * context 
)
+
+

Set the user context for a connection.

+
Parameters
+ + + +
connConnection object supplied in QD_CONN_EVENT_{LISTENER,CONNETOR}_OPEN
contextUser context to be stored with the connection.
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void qd_connection_set_link_context (qd_connection_tconn,
void * context 
)
+
+

Set the link context for a connection.

+
Parameters
+ + + +
connConnection object supplied in QD_CONN_EVENT_{LISTENER,CONNETOR}_OPEN
contextLink context to be stored with the connection.
+
+
+ +
+
+ +
+
+ + + + + + + + +
void qd_server_activate (qd_connection_tconn)
+
+

Activate a connection for output.

+

This function is used to request that the server activate the indicated connection. It is assumed that the connection is one that the caller does not have permission to access (i.e. it may be owned by another thread currently). An activated connection will, when writable, appear in the internal work list and be invoked for processing by a worker thread.

+
Parameters
+ + +
connThe connection over which the application wishes to send data
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
qd_connector_t* qd_server_connect (qd_dispatch_tqd,
const qd_server_config_tconfig,
void * context 
)
+
+

Create a connector for an outgoing connection.

+
Parameters
+ + + + +
qdThe dispatch handle returned by qd_dispatch.
configPointer to a configuration block for this connector. This block will be referenced by the server, not copied. The referenced record must remain in-scope for the life of the connector..
contextUser context passed back in the connection handler.
+
+
+
Returns
A pointer to the new connector, or NULL in case of failure.
+ +
+
+ +
+
+ + + + + + + + +
void qd_server_connector_free (qd_connector_tct)
+
+

Free the resources associated with a connector.

+
Parameters
+ + +
ctA connector pointer returned by qd_connect.
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
qd_listener_t* qd_server_listen (qd_dispatch_tqd,
const qd_server_config_tconfig,
void * context 
)
+
+

Create a listener for incoming connections.

+
Parameters
+ + + + +
qdThe dispatch handle returned by qd_dispatch.
configPointer to a configuration block for this listener. This block will be referenced by the server, not copied. The referenced record must remain in-scope for the life of the listener.
contextUser context passed back in the connection handler.
+
+
+
Returns
A pointer to the new listener, or NULL in case of failure.
+ +
+
+ +
+
+ + + + + + + + +
void qd_server_listener_close (qd_listener_tli)
+
+

Close a listener so it will accept no more connections.

+
Parameters
+ + +
liA listener pointer returned by qd_listen.
+
+
+ +
+
+ +
+
+ + + + + + + + +
void qd_server_listener_free (qd_listener_tli)
+
+

Free the resources associated with a listener.

+
Parameters
+ + +
liA listener pointer returned by qd_listen.
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void qd_server_set_conn_handler (qd_dispatch_tqd,
qd_conn_handler_cb_t conn_handler,
void * handler_context 
)
+
+

Set the connection event handler callback.

+

Set the connection handler callback for the server. This callback is mandatory and must be set prior to the invocation of qd_server_run.

+
Parameters
+ + + + +
qdThe dispatch handle returned by qd_dispatch.
conn_handlerThe handler for processing connection-related events.
handler_contextContext data to associate with the handler.
+
+
+ +
+
+
+
+ + + + Added: qpid/site/docs/releases/qpid-dispatch-trunk/api/group__connection.js URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-trunk/api/group__connection.js?rev=1653654&view=auto ============================================================================== --- qpid/site/docs/releases/qpid-dispatch-trunk/api/group__connection.js (added) +++ qpid/site/docs/releases/qpid-dispatch-trunk/api/group__connection.js Wed Jan 21 21:07:42 2015 @@ -0,0 +1,50 @@ +var group__connection = +[ + [ "qd_server_config_t", "structqd__server__config__t.html", [ + [ "allow_no_sasl", "structqd__server__config__t.html#aa0e7cea7d72ffa66747c11f0e8ea4284", null ], + [ "allow_redirect", "structqd__server__config__t.html#a4ad78634be375e1ae3d4f1d46fe87db8", null ], + [ "host", "structqd__server__config__t.html#a0d6a7f92cdbcfc12c32e7e0a5b14a717", null ], + [ "max_frame_size", "structqd__server__config__t.html#a29e5967718878325184e9b05504a30ba", null ], + [ "port", "structqd__server__config__t.html#a1864e6754c35aacb104683772ae15886", null ], + [ "role", "structqd__server__config__t.html#a9c644c021f0873cb1b625d4dd38cd32f", null ], + [ "sasl_maxssf", "structqd__server__config__t.html#a42ee62f5e475686c953256a89ec86874", null ], + [ "sasl_mechanisms", "structqd__server__config__t.html#a472635940f59c08ffed94ae84fd132d2", null ], + [ "sasl_minssf", "structqd__server__config__t.html#a11ec26cf279f3ab0d63e24a1ed46115a", null ], + [ "sasl_password", "structqd__server__config__t.html#a71206ea5155034117058b290c6ee6a45", null ], + [ "sasl_username", "structqd__server__config__t.html#ac297f12b6f4d83e32811ed4988bf4754", null ], + [ "ssl_allow_unsecured_client", "structqd__server__config__t.html#aefbe71d2d544319249507c7f3a460ae7", null ], + [ "ssl_certificate_file", "structqd__server__config__t.html#ae90080060c778b98e1321284f890d763", null ], + [ "ssl_enabled", "structqd__server__config__t.html#ac0a6a1acaba3942143c55fc11d0e8f0d", null ], + [ "ssl_password", "structqd__server__config__t.html#adb620ebdae33c5147c1277cf7a9ffa33", null ], + [ "ssl_private_key_file", "structqd__server__config__t.html#a9cfd6bc0240a3646fa8e28e5fb9f6227", null ], + [ "ssl_require_peer_authentication", "structqd__server__config__t.html#ab3d8f17f6aee630ac4693275b028c1c6", null ], + [ "ssl_server", "structqd__server__config__t.html#a296e37b46e8bdc62ac9d8bd5d03b0c62", null ], + [ "ssl_trusted_certificate_db", "structqd__server__config__t.html#aeb088a79cf79981c7ada7018e7b49c83", null ], + [ "ssl_trusted_certificates", "structqd__server__config__t.html#ab145985f715f9d0e5f2d2c167aaab613", null ] + ] ], + [ "qd_conn_handler_cb_t", "group__connection.html#ga2dff0f64365e68a27028b224ffa4979d", null ], + [ "qd_connection_t", "group__connection.html#gaf96c9049b69572b655812ee8e54ce79e", null ], + [ "qd_connector_t", "group__connection.html#ga772722c1885896e352cc6b841be1ffd9", null ], + [ "qd_listener_t", "group__connection.html#ga85e85e202d9437e86ac36b201f4aeb28", null ], + [ "qd_server_config_t", "group__connection.html#ga4901e4ac2b1118bf486d5fcb7da781aa", null ], + [ "qd_conn_event_t", "group__connection.html#ga8e039613b3caf4b4db9449a95f481bba", [ + [ "QD_CONN_EVENT_LISTENER_OPEN", "group__connection.html#gga8e039613b3caf4b4db9449a95f481bbaa5cad2e9d92ce4df7c303d0a4be4be3af", null ], + [ "QD_CONN_EVENT_CONNECTOR_OPEN", "group__connection.html#gga8e039613b3caf4b4db9449a95f481bbaa37b15513ced09c37bc7137548eac01f7", null ], + [ "QD_CONN_EVENT_CLOSE", "group__connection.html#gga8e039613b3caf4b4db9449a95f481bbaa2ca61841629392964041e4f1ddd02104", null ], + [ "QD_CONN_EVENT_PROCESS", "group__connection.html#gga8e039613b3caf4b4db9449a95f481bbaa25769cd843665c1b9200393ae09f523b", null ] + ] ], + [ "qd_connection_collector", "group__connection.html#gad472a5ac753c1a1f7dad1df41d2754c3", null ], + [ "qd_connection_config", "group__connection.html#ga72e73f38f725365c8cac0ef032cb792f", null ], + [ "qd_connection_get_context", "group__connection.html#ga107b8dc0204c301305cfc9a7edc51d40", null ], + [ "qd_connection_get_link_context", "group__connection.html#ga6f164a770f888593411284d9cae2ad30", null ], + [ "qd_connection_pn", "group__connection.html#gaab145ce6eacb1f1820dfaed00823d492", null ], + [ "qd_connection_set_context", "group__connection.html#ga5d92400b6209102763f75d8d23da5d62", null ], + [ "qd_connection_set_link_context", "group__connection.html#ga0fccc52fd8e44cadaf948f19f4cefdd2", null ], + [ "qd_server_activate", "group__connection.html#gaf5b1f2a74c4152c84862f913c9aaece0", null ], + [ "qd_server_connect", "group__connection.html#gad88726ffcecec2cc2125b3160384eea4", null ], + [ "qd_server_connector_free", "group__connection.html#gae19f1945ab1df70424ce519e527ca29a", null ], + [ "qd_server_listen", "group__connection.html#ga2b365e77e4f34a24232eb8cf2902e442", null ], + [ "qd_server_listener_close", "group__connection.html#gac8e3406c4fbc0f17cc25fa2cb7a5bd15", null ], + [ "qd_server_listener_free", "group__connection.html#ga30b52672d5a3fcd96a75a7647e82cc57", null ], + [ "qd_server_set_conn_handler", "group__connection.html#gaea7e342da86722c692bec3aca092b939", null ] +]; \ No newline at end of file Modified: qpid/site/docs/releases/qpid-dispatch-trunk/api/group__container.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-trunk/api/group__container.html?rev=1653654&r1=1653653&r2=1653654&view=diff ============================================================================== --- qpid/site/docs/releases/qpid-dispatch-trunk/api/group__container.html (original) +++ qpid/site/docs/releases/qpid-dispatch-trunk/api/group__container.html Wed Jan 21 21:07:42 2015 @@ -4,7 +4,7 @@ -Qpid Dispatch Library API: Container +Qpid Dispatch Library API: container @@ -94,7 +94,7 @@ $(document).ready(function(){initNavTree Enumerations | Functions
-
Container
+
container
@@ -102,8 +102,6 @@ $(document).ready(function(){initNavTree Classes - -
struct  qd_node_type_t
 
struct  qd_link_item_t
 
@@ -132,10 +130,8 @@ Typedefs - + - -

Macros

 
typedef void(* qd_container_node_handler_t )(void *type_context, qd_node_t *node)
 
typedef void(* qd_container_conn_handler_t )(void *type_context, qd_connection_t *conn, void *context)
typedef void(* qd_container_conn_handler_t )(void *type_context, qd_connection_t *conn, void *context)
 
typedef struct qd_link_item_t qd_link_item_t
 
@@ -170,7 +166,7 @@ Functions - + @@ -182,7 +178,7 @@ Functions - + @@ -232,10 +228,6 @@ Functions - - - -

Enumerations

 
qd_lifetime_policy_t qd_container_node_get_life_policy (const qd_node_t *node)
 
qd_link_tqd_link (qd_node_t *node, qd_connection_t *conn, qd_direction_t dir, const char *name)
qd_link_tqd_link (qd_node_t *node, qd_connection_t *conn, qd_direction_t dir, const char *name)
 
void qd_link_free (qd_link_t *link)
 
 
void * qd_link_get_conn_context (qd_link_t *link)
 
qd_connection_tqd_link_connection (qd_link_t *link)
qd_connection_tqd_link_connection (qd_link_t *link)
 
pn_link_t * qd_link_pn (qd_link_t *link)
 
 
qd_link_tqd_delivery_link (qd_delivery_t *delivery)
 
 ALLOC_DECLARE (qd_link_item_t)
 
 DEQ_DECLARE (qd_link_item_t, qd_link_list_t)
 

Detailed Description

Container for nodes, links and deliveries.

@@ -282,7 +274,7 @@ Functions
- +
typedef void(* qd_container_conn_handler_t)(void *type_context, qd_connection_t *conn, void *context)typedef void(* qd_container_conn_handler_t)(void *type_context, qd_connection_t *conn, void *context)
@@ -361,18 +353,6 @@ Functions
- -
-
- - - - -
typedef struct qd_link_item_t qd_link_item_t
-
- -
-
@@ -443,48 +423,6 @@ Functions

Function Documentation

- -
-
- - - - - - - - -
ALLOC_DECLARE (qd_link_item_t )
-
- -
-
- -
-
- - - - - - - - - - - - - - - - - - -
DEQ_DECLARE (qd_link_item_t ,
qd_link_list_t  
)
-
- -
-
@@ -967,7 +905,7 @@ Functions - qd_connection_t *  + qd_connection_tconn, @@ -1029,7 +967,7 @@ Functions
- + Modified: qpid/site/docs/releases/qpid-dispatch-trunk/api/group__container.js URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-trunk/api/group__container.js?rev=1653654&r1=1653653&r2=1653654&view=diff ============================================================================== --- qpid/site/docs/releases/qpid-dispatch-trunk/api/group__container.js (original) +++ qpid/site/docs/releases/qpid-dispatch-trunk/api/group__container.js Wed Jan 21 21:07:42 2015 @@ -15,10 +15,6 @@ var group__container = [ "type_name", "structqd__node__type__t.html#ae90b03772aba782dfefc83866794aa6b", null ], [ "writable_handler", "structqd__node__type__t.html#aa6ae0251bf4a1f206462060b3a061667", null ] ] ], - [ "qd_link_item_t", "structqd__link__item__t.html", [ - [ "DEQ_LINKS", "structqd__link__item__t.html#aa0d191a3633a3713cb9f00b47969d50b", null ], - [ "link", "structqd__link__item__t.html#a503a0e8b1f48b735f204cb88c1705420", null ] - ] ], [ "QD_DIST_BOTH", "group__container.html#gaaaf629a9b77320fbaf7bd2bd290fb996", null ], [ "QD_DIST_COPY", "group__container.html#gadcae52b06ae1288f76543aff0e485b6f", null ], [ "QD_DIST_MOVE", "group__container.html#gadbc700d67974fb9a363917dc0cafdad7", null ], @@ -29,7 +25,6 @@ var group__container = [ "qd_container_node_handler_t", "group__container.html#gaf223d818cc70e16f812ae6b4e05d5ca5", null ], [ "qd_delivery_t", "group__container.html#ga42734cb017f1ba5af285ccb28df0cea6", null ], [ "qd_dist_mode_t", "group__container.html#ga2e680520d548e67e2efd6ee95ce377d9", null ], - [ "qd_link_item_t", "group__container.html#ga30539ae192fa0796ec70bb2e51c16bec", null ], [ "qd_link_t", "group__container.html#ga082a4e64f813ba6e3a3587913e5905f2", null ], [ "qd_node_t", "group__container.html#gabcd15e2c4befdba7b0857ae224c2aa43", null ], [ "qd_direction_t", "group__container.html#gab7d2a7aff97298deeb9e253518cd6693", [ @@ -43,8 +38,6 @@ var group__container = [ "QD_LIFE_DELETE_NO_MESSAGES", "group__container.html#ggabb6751c1530343f02b816cd4302497edaa478496cbadc68c88f5f7860ee6708e7", null ], [ "QD_LIFE_DELETE_NO_LINKS_MESSAGES", "group__container.html#ggabb6751c1530343f02b816cd4302497edaebf583e3a6f712850e5f14e32ad3ea25", null ] ] ], - [ "ALLOC_DECLARE", "group__container.html#ga560fb0cf0c783c7264ec1d8e5bfac58a", null ], - [ "DEQ_DECLARE", "group__container.html#ga8bbc3e97e3688a64995d8afd36aa71c9", null ], [ "qd_container_create_node", "group__container.html#ga8abfb3c5c5260291de0976fb3e2b06e7", null ], [ "qd_container_destroy_node", "group__container.html#gac2a7df1d8de2cff060bafe30df23194b", null ], [ "qd_container_node_get_dist_modes", "group__container.html#ga9b1bde2fa7f6512896adc337a4911729", null ], Modified: qpid/site/docs/releases/qpid-dispatch-trunk/api/group__dispatch.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-trunk/api/group__dispatch.html?rev=1653654&r1=1653653&r2=1653654&view=diff ============================================================================== --- qpid/site/docs/releases/qpid-dispatch-trunk/api/group__dispatch.html (original) +++ qpid/site/docs/releases/qpid-dispatch-trunk/api/group__dispatch.html Wed Jan 21 21:07:42 2015 @@ -4,7 +4,7 @@ -Qpid Dispatch Library API: Dispatch +Qpid Dispatch Library API: dispatch @@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree Typedefs | Functions
-
Dispatch
+
dispatch
qd_connection_t* qd_link_connection qd_connection_t* qd_link_connection ( qd_link_t link)
@@ -110,7 +110,6 @@ Functions
 

Detailed Description

-

Configure and prepare a dispatch instance.

Typedef Documentation

@@ -165,7 +164,7 @@ Functions

Finalize the Dispatch library after it has stopped running.

Parameters
- +
dispatchThe dispatch handle returned by qd_dispatch
qdThe dispatch handle returned by qd_dispatch
@@ -198,7 +197,7 @@ Functions

Load the configuration file.

Parameters
- +
dispatchThe dispatch handle returned by qd_dispatch
qdThe dispatch handle returned by qd_dispatch
config_pathThe path to the configuration file.
Modified: qpid/site/docs/releases/qpid-dispatch-trunk/api/group__iterator.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-trunk/api/group__iterator.html?rev=1653654&r1=1653653&r2=1653654&view=diff ============================================================================== --- qpid/site/docs/releases/qpid-dispatch-trunk/api/group__iterator.html (original) +++ qpid/site/docs/releases/qpid-dispatch-trunk/api/group__iterator.html Wed Jan 21 21:07:42 2015 @@ -4,7 +4,7 @@ -Qpid Dispatch Library API: Iterator +Qpid Dispatch Library API: iterator @@ -92,7 +92,7 @@ $(document).ready(function(){initNavTree Enumerations | Functions
-
Iterator
+
iterator
@@ -184,20 +184,46 @@ Functions
-

Iterator views allow the code traversing the field to see a transformed view of the raw field.

+

Type of iterator view. Iterator views allow the code traversing an address field to see a transformed view of the raw field.

ITER_VIEW_ALL - No transformation of the raw field data

-

ITER_VIEW_NO_HOST - Remove the scheme and host fields from the view

-

amqp://host.domain.com:port/node-id/node/specific ^^^^^^^^^^^^^^^^^^^^^ node-id/node/specific ^^^^^^^^^^^^^^^^^^^^^

-

ITER_VIEW_NODE_ID - Isolate the node identifier from an address

-

amqp://host.domain.com:port/node-id/node/specific ^^^^^^^ node-id/node/specific ^^^^^^^

-

ITER_VIEW_NODE_SPECIFIC - Isolate node-specific text from an address

-

amqp://host.domain.com:port/node-id/node/specific ^^^^^^^^^^^^^ node-id/node/specific ^^^^^^^^^^^^^

-

ITER_VIEW_ADDRESS_HASH - Isolate the hashable part of the address depending on address syntax

-

amqp:/_local/<local> L^^^^^^^ amqp:/_topo/<area>/<router>/<local> A^^^^^^ amqp:/_topo/<my-area>/<router>/<local> R^^^^^^^^ amqp:/_topo/<my_area>/<my-router>/<local> L^^^^^^^ amqp:/_topo/<area>/all/<local> A^^^^^^ amqp:/_topo/<my-area>/all/<local> L^^^^^^^ amqp:/_topo/all/all/<local> L^^^^^^^ amqp:/<mobile> M^^^^^^^^

-

ITER_VIEW_NODE_HASH - Isolate the hashable part of a router-id, used for headers

-

<area>/<router> A^^^^^^

-

<my_area>/<router> R^^^^^^^^

- +

ITER_VIEW_NO_HOST - Remove the scheme and host fields from the view

+
amqp://host.domain.com:port/node-id/node/specific
+                            ^^^^^^^^^^^^^^^^^^^^^
+node-id/node/specific
+^^^^^^^^^^^^^^^^^^^^^
+

ITER_VIEW_NODE_ID - Isolate the node identifier from an address

+
amqp://host.domain.com:port/node-id/node/specific
+                           ^^^^^^^
+node-id/node/specific
+^^^^^^^
+

ITER_VIEW_NODE_SPECIFIC - Isolate node-specific text from an address

+
amqp://host.domain.com:port/node-id/node/specific
+                                    ^^^^^^^^^^^^^
+node-id/node/specific
+        ^^^^^^^^^^^^^
+

ITER_VIEW_ADDRESS_HASH - Isolate the hashable part of the address depending on address syntax

+
amqp:/_local/<local>
+            L^^^^^^^
+amqp:/_topo/<area>/<router>/<local>
+           A^^^^^^
+amqp:/_topo/<my-area>/<router>/<local>
+                     R^^^^^^^^
+amqp:/_topo/<my_area>/<my-router>/<local>
+                                 L^^^^^^^
+amqp:/_topo/<area>/all/<local>
+           A^^^^^^
+amqp:/_topo/<my-area>/all/<local>
+                         L^^^^^^^
+amqp:/_topo/all/all/<local>
+                   L^^^^^^^
+amqp:/<mobile>
+     M^^^^^^^^
+

ITER_VIEW_NODE_HASH - Isolate the hashable part of a router-id, used for headers

+
 <area>/<router>
+A^^^^^^
+
+ <my_area>/<router>
+          R^^^^^^^^
Enumerator
ITER_VIEW_ALL 
ITER_VIEW_NO_HOST  Modified: qpid/site/docs/releases/qpid-dispatch-trunk/api/group__message.html URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-trunk/api/group__message.html?rev=1653654&r1=1653653&r2=1653654&view=diff ============================================================================== --- qpid/site/docs/releases/qpid-dispatch-trunk/api/group__message.html (original) +++ qpid/site/docs/releases/qpid-dispatch-trunk/api/group__message.html Wed Jan 21 21:07:42 2015 @@ -4,7 +4,7 @@ -Qpid Dispatch Library API: Message +Qpid Dispatch Library API: message @@ -93,7 +93,7 @@ $(document).ready(function(){initNavTree Enumerations | Functions
-
Message
+
message
+

Amount of message to be parsed.

@@ -252,6 +253,7 @@ Functions
Enumerator
QD_DEPTH_NONE 
+

Message fields

@@ -646,7 +648,7 @@ Functions
Enumerator
QD_FIELD_HEADER 
- + --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org For additional commands, e-mail: commits-help@qpid.apache.org
qd_parsed_field_t* qd_message_message_annotations qd_parsed_field_t* qd_message_message_annotations ( qd_message_t msg)