http://git-wip-us.apache.org/repos/asf/qpid-site/blob/ba8436ae/content/releases/qpid-proton-0.24.0/proton/c/api/connection_8h_source.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-0.24.0/proton/c/api/connection_8h_source.html b/content/releases/qpid-proton-0.24.0/proton/c/api/connection_8h_source.html new file mode 100755 index 0000000..6bdd228 --- /dev/null +++ b/content/releases/qpid-proton-0.24.0/proton/c/api/connection_8h_source.html @@ -0,0 +1,150 @@ + + + + + + + +Qpid Proton C API: proton/connection.h Source File + + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
Qpid Proton C API +  0.24.0 +
+
+ + + + + + +
+
+
+ + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
connection.h
+
+
+Go to the documentation of this file.
1 #ifndef PROTON_CONNECTION_H
2 #define PROTON_CONNECTION_H 1
3 
4 /*
5  *
6  * Licensed to the Apache Software Foundation (ASF) under one
7  * or more contributor li cense agreements. See the NOTICE file
8  * distributed with this work for additional information
9  * regarding copyright ownership. The ASF licenses this file
10  * to you under the Apache License, Version 2.0 (the
11  * "License"); you may not use this file except in compliance
12  * with the License. You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing,
17  * software distributed under the License is distributed on an
18  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
19  * KIND, either express or implied. See the License for t he
20  * specific language governing permissions and limitations
21  * under the License.
22  *
23  */
24 
25 #include <proton/import_export.h>
26 #include <proton/codec.h>
27 #include <proton/condition.h>
28 #include <proton/error.h>
29 #include <proton/type_compat.h>
30 #include <proton/types.h>
31 
32 #include <stddef.h>
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
50 #define PN_LOCAL_UNINIT (1)
51 
55 #define PN_LOCAL_ACTIVE (2)
56 
60 #define PN_LOCAL_CLOSED (4)
61 
65 #define PN_REMOTE_UNINIT (8)
66 
70 # define PN_REMOTE_ACTIVE (16)
71 
75 #define PN_REMOTE_CLOSED (32)
76 
81 #define PN_LOCAL_MASK (PN_LOCAL_UNINIT | PN_LOCAL_ACTIVE | PN_LOCAL_CLOSED)
82 
87 #def ine PN_REMOTE_MASK (PN_REMOTE_UNINIT | PN_REMOTE_ACTIVE | PN_REMOTE_CLOSED)
88 
89 PN_EXTERN pn_connection_t *pn_connection(void);
90 
96 PN_EXTERN pn_connection_t *pn_connection(void);
97& #160;
107 PN_EXTERN void pn_connection_free(pn_connection_t *connection);
108 
118 PN_EXTERN void pn_connection_release(pn_connection_t *connection);
119 
136 PN_EXTERN pn_error_t *pn_connection_error(pn_connection_t *connection);
137 
156 PN_EXTERN void pn_connection_collect(pn_connection_t *connection, pn_collector_t *collector);
157 
163 
176 PN_EXTERN void *pn_connection_get_context(pn_connection_t *connection);
177 
189 PN_EXTERN void pn_connection_set_context(pn_connection_t *connection, void *context);
190 
197 PN_EXTERN pn_record_t *pn_connection_attachments(pn_connection_t *connection);
198 
205 PN_EXTERN pn_state_t pn_connection_state(pn_connection_t *connection);
206 
215 PN_EXTERN void pn_connection_open(pn_connection_t *connection);
216 
227 PN_EXTERN void pn_connection_close(pn_connection_t *connection);
228 
237 PN_EXTERN void pn_connection_reset(pn_connection_t *connection);
238 
256 
272 
283 PN_EXTERN const char *pn_connection_get_container(pn_connection_t *connection);
< a name="l00284"> 284 
291 PN_EXTERN void pn_connection_set_container(pn_connection_t *connection, const char *container);
292 
307 PN_EXTERN void pn_connection_set_user(pn_connection_t *connection, const char *user);
308 
322 PN_EXTERN void pn_connection_set_password(pn_connection_t *connection, const char *password);
323 
330 PN_EXTERN const char *pn_connection_get_user(pn_con nection_t *connection);
331 
342 PN_EXTERN const char *pn_connection_get_hostname(pn_connection_t *connection);
343 
357 PN_EXTERN void pn_connection_set_hostname(pn_connection_t *connection, const char *hostname);
358 
373 PN_EXTERN const char *pn_connection_remote_container(pn_connection_t *connection);
374 
388 PN_EXTERN const char *pn_connection_remote_hostname(pn_connection_t *connection);
389 
407 
425 
441 PN_EXTERN pn_data_t *pn_connection_properties(pn_connection_t *connection);
442 
456 
470 
484 
495 
500 #ifdef __cplusplus
501 }
502 #endif
503 
504 #endif /* connection.h */
void * pn_connection_get_context(pn_connection_t *connection)
Deprecated - Use pn_connection_attachments().
+
pn_data_t * pn_connection_remote_properties(pn_connection_t *connection)
Access the AMQP connection properties supplied by the remote connection endpoint. ...
+
AMQP and API data types.
+
pn_condition_t * pn_connection_remote_condition(pn_connection_t *connection)
Get the remote condition associated with the connection endpoint.
+
pn_state_t pn_connection_state(pn_connection_t *connection)
Get the endpoint state flags for a connection.
+
struct pn_transport_t pn_transport_t
A network channel supporting an AMQP connection.
Definition: types.h:431
+
AMQP data encoding and decoding.
+
pn_data_t * pn_connection_remote_desired_capabilities(pn_connection_t *connection)
Access the AMQP desired capabilities supplied by the remote connection endpoint.
+
const char * pn_connection_remote_container(pn_connection_t *connection)
Get the AMQP Container name advertised by the remote connection endpoint.
+
struct pn_error_t pn_error_t
An int error code and some string text to describe the error.
Definition: error.h:44
+
void pn_connection_set_user(pn_connection_t *connection, const char *user)
Set the authentication username for a client connection.
+
struct pn_collector_t pn_collector_t
An event collector.
Definition: types.h:413
+
A Proton API error.
+
pn_data_t * pn_connection_desired_capabilities(pn_connection_t *connection)
Access/modify the AMQP desired capabilities data for a connection object.
+
void pn_connection_free(pn_connection_t *connection)
Free a connection object.
+
An endpoint error state.
+
pn_condition_t * pn_connection_condition(pn_connection_t *connection)
Get the local condition associated with the connection endpoint.
+
void pn_connection_set_context(pn_connection_t *connection, void *context)
Deprecated - Use pn_connection_attachments().
+
const char * pn_connection_get_container(pn_connection_t *connection)
Get the AMQP Container name advertised by a connection object.
+
pn_data_t * pn_connection_offered_capabilities(pn_connection_t *connection)
Access/modify the AMQP offered capabilities data for a connection object.
+
pn_record_t * pn_connection_attachments(pn_connection_t *connection)
Get the attachments that are associated with a connection object.
+
const char * pn_connection_get_hostname(pn_connection_t *connection)
Get the value of the AMQP Hostname used by a connection object.
+
void pn_connection_close(pn_connection_t *connection)
Close a connection.
+
struct pn_data_t pn_data_t
An AMQP Data object.
Definition: codec.h:364
+
void pn_connection_set_password(pn_connection_t *connection, const char *password)
Set the authentication password for a client connection.
+
pn_data_t * pn_connection_properties(pn_connection_t *connection)
Access/modify the AMQP properties data for a connection object.
+
void pn_connection_release(pn_connection_t *connection)
Release a connection object.
+
pn_data_t * pn_connection_remote_offered_capabilities(pn_connection_t *connection)
Access the AMQP offered capabilities supplied by the remote connection endpoint.
+
void pn_connection_set_container(pn_connection_t *connection, const char *container)
Set the AMQP Container name advertised by a connection object.
+
void pn_connection_collect(pn_connection_t *connection, pn_collector_t *collector)
Associate a connection object with an event collector.
+
void pn_connection_open(pn_connection_t *connection)
Open a connection.
+
struct pn_connection_t pn_connection_t
An AMQP Connection object.
Definition: types.h:281
+
const char * pn_connection_get_user(pn_connection_t *connection)
Get the authentication username for a client connection.
+
const char * pn_connection_remote_hostname(pn_connection_t *connection)
Get the AMQP Hostname set by the remote connection endpoint.
+
struct pn_condition_t pn_condition_t
An AMQP Condition object.
Definition: condition.h:64
+
pn_error_t * pn_connection_error(pn_connection_t *connection)
Deprecated
+
int pn_state_t
Holds the state flags for an AMQP endpoint.
Definition: types.h:267
+
pn_connection_t * pn_connection(void)
Factory to construct a new Connection.
+
void pn_connection_set_hostname(pn_connection_t *connection, const char *hostname)
Set the name of the virtual host (either fully qualified or relative) to which this connection is con...
+
pn_transport_t * pn_connection_transport(pn_connection_t *connection)
Get the transport bound to a connection object.
+
void pn_connection_reset(pn_connection_t *connection)
Reset a connection object back to the uninitialized state.
+
pn_collector_t * pn_connection_collector(pn_connection_t *connection)
Get the collector set with pn_connection_collect()
+
+
+ + + + http://git-wip-us.apache.org/repos/asf/qpid-site/blob/ba8436ae/content/releases/qpid-proton-0.24.0/proton/c/api/connection__driver_8h.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-0.24.0/proton/c/api/connection__driver_8h.html b/content/releases/qpid-proton-0.24.0/proton/c/api/connection__driver_8h.html new file mode 100755 index 0000000..86189ab --- /dev/null +++ b/content/releases/qpid-proton-0.24.0/proton/c/api/connection__driver_8h.html @@ -0,0 +1,229 @@ + + + + + + + +Qpid Proton C API: proton/connection_driver.h File Reference + + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
Qpid Proton C API +  0.24.0 +
+
+ + + + + + +
+
+
+ + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+ +
+
connection_driver.h File Reference
+
+
+ +

Unsettled API - An API for low-level IO integration. +More...

+
#include <proton/import_export.h>
+#include <proton/event.h>
+#include <proton/types.h>
+#include <stdarg.h>
+
+

Go to the source code of this file.

+ + + + + +

+Classes

struct  pn_connection_driver_t
 The elements needed to drive AMQP IO and events. More...
 
+ + + + + + + +

+Macros

#define PN_TRANSPORT_WRITE_CLOSED
 The write side of the transport is closed, it will no longer produce bytes to write to external IO. More...
 
#define PN_TRANSPORT_READ_CLOSED
 The read side of the transport is closed, it will no longer read bytes from external IO. More...
 
+ + + + +

+Typedefs

+typedef struct pn_connection_driver_t pn_connection_driver_t
 The elements needed to drive AMQP IO and events.
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Functions

int pn_connection_driver_init (pn_connection_driver_t *, pn_connection_t *, pn_transport_t *)
 Set connection and transport to the provided values, or create a new pn_connection_t or pn_transport_t if either is NULL. More...
 
int pn_connection_driver_bind (pn_connection_driver_t *d)
 Force binding of the transport. More...
 
void pn_connection_driver_destroy (pn_connection_driver_t *)
 Unbind, release and free the connection and transport. More...
 
pn_connection_tpn_connection_driver_release_connection (pn_connection_driver_t *d)
 Disassociate the driver's connection from its transport and collector and sets d->connection = NULL. More...
 
pn_rwbytes_t pn_connection_driver_read_buffer (pn_connection_driver_t *)
 Get the read buffer. More...
 
+void pn_connection_driver_read_done (pn_connection_driver_t *, size_t n)
 Process the first n bytes of data in pn_connection_driver_read_buffer() and reclaim the buffer space.
 
void pn_connection_driver_read_close (pn_connection_driver_t *)
 Close the read side. More...
 
+bool pn_connection_driver_read_closed (pn_connection_driver_t *)
 True if read side is closed.
 
pn_bytes_t pn_connection_driver_write_buffer (pn_connection_driver_t *)
 Get the write buffer. More...
 
void pn_connection_driver_write_done (pn_connection_driver_t *, size_t n)
 Call when the first n bytes of pn_connection_driver_write_buffer() have been written to IO. More...
 
void pn_connection_driver_write_close (pn_connection_driver_t *)
 Close the write side. More...
 
+bool pn_connection_driver_write_closed (pn_connection_driver_t *)
 True if write side is closed.
 
+void pn_connection_driver_close (pn_connection_driver_t *c)
 Close both sides.
 
pn_event_tpn_connection_driver_next_event (pn_connection_driver_t *)
 Get the next event to handle. More...
 
+bool pn_connection_driver_has_event (pn_connection_driver_t *)
 True if pn_connection_driver_next_event() will return a non-NULL event.
 
bool pn_connection_driver_finished (pn_connection_driver_t *)
 Return true if the the driver is closed for reading and writing and there are no more events. More...
 
void pn_connection_driver_errorf (pn_connection_driver_t *d, const char *name, const char *fmt,...)
 Set transport error. More...
 
+void pn_connection_driver_verrorf (pn_connection_driver_t *d, const char *name, const char *fmt, va_list)
 Set transport error via a va_list, see pn_connection_driver_errorf()
 
+pn_connection_driver_tpn_event_batch_connection_driver (pn_event_batch_t *batch)
 If batch is part of a connection_driver, return the connection_driver address, else return NULL.
 
+void pn_connection_driver_log (pn_connection_driver_t *d, const char *msg)
 Deprecated - Use pn_transport_log().
 
+void pn_connection_driver_logf (pn_connection_driver_t *d, const char *fmt,...)
 Deprecated - Use pn_transport_logf().
 
+void pn_connection_driver_vlogf (pn_connection_driver_t *d, const char *fmt, va_list ap)
 Deprecated - Use pn_transport_vlogf().
 
pn_connection_driver_t ** pn_connection_driver_ptr (pn_connection_t *connection)
 Associate a pn_connection_t with its pn_connection_driver_t. More...
 
+

Detailed Description

+

Unsettled API - An API for low-level IO integration.

+
+
+ + + + http://git-wip-us.apache.org/repos/asf/qpid-site/blob/ba8436ae/content/releases/qpid-proton-0.24.0/proton/c/api/connection__driver_8h.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-0.24.0/proton/c/api/connection__driver_8h.js b/content/releases/qpid-proton-0.24.0/proton/c/api/connection__driver_8h.js new file mode 100755 index 0000000..fe20c1e --- /dev/null +++ b/content/releases/qpid-proton-0.24.0/proton/c/api/connection__driver_8h.js @@ -0,0 +1,29 @@ +var connection__driver_8h = +[ + [ "PN_TRANSPORT_WRITE_CLOSED", "group__connection__driver.html#ga56e55c7d0343529b7fb3002b930a36b2", null ], + [ "PN_TRANSPORT_READ_CLOSED", "group__connection__driver.html#ga9a331416719994f6cb0971acce5208fb", null ], + [ "pn_connection_driver_t", "group__connection__driver.html#ga9793522a25c9741e8d17a570a47e9711", null ], + [ "pn_connection_driver_init", "group__connection__driver.html#ga2330d329e295da740ef8d126657470c6", null ], + [ "pn_connection_driver_bind", "group__connection__driver.html#gad2bdef0f5abe7cf593afcee237c6af56", null ], + [ "pn_connection_driver_destroy", "group__connection__driver.html#ga3e8959d7897cd9415f687981c1d94c96", null ], + [ "pn_connection_driver_release_connection", "group__connection__driver.html#ga96a6bf8efc2dd7b76734cb2432441333", null ], + [ "pn_connection_driver_read_buffer", "group__connection__driver.html#ga0dd152968de6ec06de352e1cbc51c438", null ], + [ "pn_connection_driver_read_done", "group__connection__driver.html#gaa164510528ce160efddbde2245c438b1", null ], + [ "pn_connection_driver_read_close", "group__connection__driver.html#ga11b59aec2b54acdefd63dfbce8d09a3f", null ], + [ "pn_connection_driver_read_closed", "group__connection__driver.html#ga56ccde529842f18774fdf827e86afa23", null ], + [ "pn_connection_driver_write_buffer", "group__connection__driver.html#ga3e5795e14572eec632231fe9f916ca5f", null ], + [ "pn_connection_driver_write_done", "group__connection__driver.html#gaead42b6a9356214d9e2bb591af009243", null ], + [ "pn_connection_driver_write_close", "group__connection__driver.html#gafdca1cd72d6da760d3df7981085b36ce", null ], + [ "pn_connection_driver_write_closed", "group__connection__driver.html#ga001b2f3c1bfe4d24d53b93d79dccbfe3", null ], + [ "pn_connection_driver_close", "group__connection__driver.html#gad0c98415e0105efb71e8c1a8c4c1e5fb", null ], + [ "pn_connection_driver_next_event", "group__connection__driver.html#ga00b32ae810a25ba6e172d6ed870982a5", null ], + [ "pn_connection_driver_has_event", "group__connection__driver.html#gae51f2124706bb1674e2c623a2dc62da7", null ], + [ "pn_connection_driver_finished", "group__connection__driver.html#ga38f56836858b2d4a04ab961f650950d4", null ], + [ "pn_connection_driver_errorf", "group__connection__driver.html#ga373eb1f632468582d025f5d6acf9655e", null ], + [ "pn_connection_driver_verrorf", "group__connection__driver.html#gad774f90adceaf86748a0ae781f66daf2", null ], + [ "pn_event_batch_connection_driver", "group__connection__driver.html#gada5c75a658ae2814f253a91723be9baf", null ], + [ "pn_connection_driver_log", "group__connection__driver.html#gadb682f03cb66b5898c4b285353e0005e", null ], + [ "pn_connection_driver_logf", "group__connection__driver.html#ga756d1d7130b79f639d71d331f9005cab", null ], + [ "pn_connection_driver_vlogf", "group__connection__driver.html#gabf97a6a0b608fd096fcaa4f2692c2c63", null ], + [ "pn_connection_driver_ptr", "group__connection__driver.html#gab9d4f3255c83d7792fc17e5a020ff1c0", null ] +]; \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org For additional commands, e-mail: commits-help@qpid.apache.org