Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 4CDB9200BF5 for ; Sat, 3 Dec 2016 00:22:11 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 4BAB9160B2B; Fri, 2 Dec 2016 23:22:11 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 39A3D160B34 for ; Sat, 3 Dec 2016 00:22:08 +0100 (CET) Received: (qmail 387 invoked by uid 500); 2 Dec 2016 23:22:07 -0000 Mailing-List: contact commits-help@qpid.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@qpid.apache.org Delivered-To: mailing list commits@qpid.apache.org Received: (qmail 99438 invoked by uid 99); 2 Dec 2016 23:22:06 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 02 Dec 2016 23:22:06 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id A257DF17F6; Fri, 2 Dec 2016 23:22:06 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: jross@apache.org To: commits@qpid.apache.org Date: Fri, 02 Dec 2016 23:22:15 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [10/51] [partial] qpid-site git commit: QPID-7553: Update the proton api gen script for changes to the C api docs; republish the proton master doc snapshot archived-at: Fri, 02 Dec 2016 23:22:11 -0000 http://git-wip-us.apache.org/repos/asf/qpid-site/blob/cd4363b2/content/releases/qpid-proton-master/proton/c/api/group__transport.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/group__transport.html b/content/releases/qpid-proton-master/proton/c/api/group__transport.html index 306c096..a6fbd7b 100755 --- a/content/releases/qpid-proton-master/proton/c/api/group__transport.html +++ b/content/releases/qpid-proton-master/proton/c/api/group__transport.html @@ -90,192 +90,209 @@ $(document).ready(function(){initNavTree('group__transport.html','');});
-Modules | Macros | Typedefs | Functions
-
Transport
Engine
+
Transport
Core
+ +

A network channel supporting an AMQP connection. +More...

- - - - - -

-Modules

 SASL
 
 SSL
 
- + + - + + - + + - + + + + +

Macros

#define PN_TRACE_OFF   (0)
+#define PN_TRACE_OFF
 Turn logging off entirely.
 
#define PN_TRACE_RAW   (1)
+#define PN_TRACE_RAW
 Log raw binary data into/out of the transport.
 
#define PN_TRACE_FRM   (2)
+#define PN_TRACE_FRM
 Log frames into/out of the transport.
 
#define PN_TRACE_DRV   (4)
#define PN_TRACE_DRV
 Log driver related events, e.g. More...
 
+#define PN_TRACE_EVT
 Log events.
 
+ - + + +

Typedefs

typedef int pn_trace_t
 Holds the trace flags for an AMQP transport. More...
 
typedef void(* pn_tracer_t) (pn_transport_t *transport, const char *message)
+typedef void(* pn_tracer_t) (pn_transport_t *transport, const char *message)
 Callback for customizing logging behaviour.
 
typedef struct pn_transport_t pn_transport_t
 An AMQP Transport object. More...
 
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Functions

PN_EXTERN pn_transport_t * pn_transport (void)
 
PN_EXTERN void pn_transport_set_server (pn_transport_t *transport)
 
PN_EXTERN void pn_transport_free (pn_transport_t *transport)
 
PN_EXTERN const char * pn_transport_get_user (pn_transport_t *transport)
 
PN_EXTERN void pn_transport_require_auth (pn_transport_t *transport, bool required)
 
PN_EXTERN bool pn_transport_is_authenticated (pn_transport_t *transport)
 
PN_EXTERN void pn_transport_require_encryption (pn_transport_t *transport, bool required)
 
PN_EXTERN bool pn_transport_is_encrypted (pn_transport_t *transport)
 
PN_EXTERN pn_condition_t * pn_transport_condition (pn_transport_t *transport)
 
PN_EXTERN pn_error_t * pn_transport_error (pn_transport_t *transport)
 
PN_EXTERN int pn_transport_bind (pn_transport_t *transport, pn_connection_t *connection)
 
PN_EXTERN int pn_transport_unbind (pn_transport_t *transport)
 
PN_EXTERN void pn_transport_trace (pn_transport_t *transport, pn_trace_t trace)
 
PN_EXTERN void pn_transport_set_tracer (pn_transport_t *transport, pn_tracer_t tracer)
 
PN_EXTERN pn_tracer_t pn_transport_get_tracer (pn_transport_t *transport)
 
PN_EXTERN void * pn_transport_get_context (pn_transport_t *transport)
 
PN_EXTERN void pn_transport_set_context (pn_transport_t *transport, void *context)
 
PN_EXTERN pn_record_t * pn_transport_attachments (pn_transport_t *transport)
 
PN_EXTERN void pn_transport_log (pn_transport_t *transport, const char *message)
 
PN_EXTERN void pn_transport_vlogf (pn_transport_t *transport, const char *fmt, va_list ap)
 
PN_EXTERN void pn_transport_logf (pn_transport_t *transport, const char *fmt,...)
 
PN_EXTERN uint16_t pn_transport_get_channel_max (pn_transport_t *transport)
 
PN_EXTERN int pn_transport_set_channel_max (pn_transport_t *transport, uint16_t channel_max)
 
PN_EXTERN uint16_t pn_transport_remote_channel_max (pn_transport_t *transport)
 
PN_EXTERN uint32_t pn_transport_get_max_frame (pn_transport_t *transport)
 
PN_EXTERN void pn_transport_set_max_frame (pn_transport_t *transport, uint32_t size)
 
PN_EXTERN uint32_t pn_transport_get_remote_max_frame (pn_transport_t *transport)
 
PN_EXTERN pn_millis_t pn_transport_get_idle_timeout (pn_transport_t *transport)
 
PN_EXTERN void pn_transport_set_idle_timeout (pn_transport_t *transport, pn_millis_t timeout)
 
PN_EXTERN pn_millis_t pn_transport_get_remote_idle_timeout (pn_transport_t *transport)
 
PN_EXTERN ssize_t pn_transport_input (pn_transport_t *transport, const char *bytes, size_t available)
 
PN_EXTERN ssize_t pn_transport_output (pn_transport_t *transport, char *bytes, size_t size)
 
PN_EXTERN ssize_t pn_transport_capacity (pn_transport_t *transport)
 
PN_EXTERN char * pn_transport_tail (pn_transport_t *transport)
 
PN_EXTERN ssize_t pn_transport_push (pn_transport_t *transport, const char *src, size_t size)
 
PN_EXTERN int pn_transport_process (pn_transport_t *transport, size_t size)
 
PN_EXTERN int pn_transport_close_tail (pn_transport_t *transport)
 
PN_EXTERN ssize_t pn_transport_pending (pn_transport_t *transport)
 
PN_EXTERN const char * pn_transport_head (pn_transport_t *transport)
 
PN_EXTERN ssize_t pn_transport_peek (pn_transport_t *transport, char *dst, size_t size)
 
PN_EXTERN void pn_transport_pop (pn_transport_t *transport, size_t size)
 
PN_EXTERN int pn_transport_close_head (pn_transport_t *transport)
 
PN_EXTERN bool pn_transport_quiesced (pn_transport_t *transport)
 
PN_EXTERN bool pn_transport_closed (pn_transport_t *transport)
 
PN_EXTERN pn_timestamp_t pn_transport_tick (pn_transport_t *transport, pn_timestamp_t now)
 
PN_EXTERN uint64_t pn_transport_get_frames_output (const pn_transport_t *transport)
 
PN_EXTERN uint64_t pn_transport_get_frames_input (const pn_transport_t *transport)
 
PN_EXTERN pn_connection_t * pn_transport_connection (pn_transport_t *transport)
 
pn_transport_t * pn_transport (void)
 Factory for creating a transport. More...
 
void pn_transport_set_server (pn_transport_t *transport)
 Configure a transport as a server. More...
 
void pn_transport_free (pn_transport_t *transport)
 Free a transport object. More...
 
const char * pn_transport_get_user (pn_transport_t *transport)
 Retrieve the authenticated user. More...
 
void pn_transport_require_auth (pn_transport_t *transport, bool required)
 Set whether a non-authenticated transport connection is allowed. More...
 
bool pn_transport_is_authenticated (pn_transport_t *transport)
 Tell whether the transport connection is authenticated. More...
 
void pn_transport_require_encryption (pn_transport_t *transport, bool required)
 Set whether a non encrypted transport connection is allowed. More...
 
bool pn_transport_is_encrypted (pn_transport_t *transport)
 Tell whether the transport connection is encrypted. More...
 
pn_condition_t * pn_transport_condition (pn_transport_t *transport)
 Get additional information about the condition of the transport. More...
 
pn_error_t * pn_transport_error (pn_transport_t *transport)
 
int pn_transport_bind (pn_transport_t *transport, pn_connection_t *connection)
 Binds the transport to an AMQP connection. More...
 
int pn_transport_unbind (pn_transport_t *transport)
 Unbinds a transport from its AMQP connection. More...
 
void pn_transport_trace (pn_transport_t *transport, pn_trace_t trace)
 Update a transports trace flags. More...
 
void pn_transport_set_tracer (pn_transport_t *transport, pn_tracer_t tracer)
 Set the tracing function used by a transport. More...
 
pn_tracer_t pn_transport_get_tracer (pn_transport_t *transport)
 Get the tracing function used by a transport. More...
 
void * pn_transport_get_context (pn_transport_t *transport)
 
void pn_transport_set_context (pn_transport_t *transport, void *context)
 
pn_record_t * pn_transport_attachments (pn_transport_t *transport)
 Get the attachments that are associated with a transport object. More...
 
void pn_transport_log (pn_transport_t *transport, const char *message)
 Log a message using a transport's logging mechanism. More...
 
void pn_transport_vlogf (pn_transport_t *transport, const char *fmt, va_list ap)
 Log a printf formatted message using a transport's logging mechanism. More...
 
void pn_transport_logf (pn_transport_t *transport, const char *fmt,...)
 Log a printf formatted message using a transport's logging mechanism. More...
 
uint16_t pn_transport_get_channel_max (pn_transport_t *transport)
 Get the maximum allowed channel for a transport. More...
 
int pn_transport_set_channel_max (pn_transport_t *transport, uint16_t channel_max)
 Set the maximum allowed channel number for a transport. More...
 
uint16_t pn_transport_remote_channel_max (pn_transport_t *transport)
 Get the maximum allowed channel of a transport's remote peer. More...
 
uint32_t pn_transport_get_max_frame (pn_transport_t *transport)
 Get the maximum frame size of a transport. More...
 
void pn_transport_set_max_frame (pn_transport_t *transport, uint32_t size)
 Set the maximum frame size of a transport. More...
 
uint32_t pn_transport_get_remote_max_frame (pn_transport_t *transport)
 Get the maximum frame size of a transport's remote peer. More...
 
pn_millis_t pn_transport_get_idle_timeout (pn_transport_t *transport)
 Get the idle timeout for a transport. More...
 
void pn_transport_set_idle_timeout (pn_transport_t *transport, pn_millis_t timeout)
 Set the idle timeout for a transport. More...
 
pn_millis_t pn_transport_get_remote_idle_timeout (pn_transport_t *transport)
 Get the idle timeout for a transport's remote peer. More...
 
ssize_t pn_transport_input (pn_transport_t *transport, const char *bytes, size_t available)
 
ssize_t pn_transport_output (pn_transport_t *transport, char *bytes, size_t size)
 
ssize_t pn_transport_capacity (pn_transport_t *transport)
 Get the amount of free space for input following the transport's tail pointer. More...
 
char * pn_transport_tail (pn_transport_t *transport)
 Get the transport's tail pointer. More...
 
ssize_t pn_transport_push (pn_transport_t *transport, const char *src, size_t size)
 Pushes the supplied bytes into the tail of the transport. More...
 
int pn_transport_process (pn_transport_t *transport, size_t size)
 Process input data following the tail pointer. More...
 
int pn_transport_close_tail (pn_transport_t *transport)
 Indicate that the input has reached End Of Stream (EOS). More...
 
ssize_t pn_transport_pending (pn_transport_t *transport)
 Get the number of pending output bytes following the transport's head pointer. More...
 
const char * pn_transport_head (pn_transport_t *transport)
 Get the transport's head pointer. More...
 
ssize_t pn_transport_peek (pn_transport_t *transport, char *dst, size_t size)
 Copies size bytes from the head of the transport to the dst pointer. More...
 
void pn_transport_pop (pn_transport_t *transport, size_t size)
 Removes size bytes of output from the pending output queue following the transport's head pointer. More...
 
int pn_transport_close_head (pn_transport_t *transport)
 Indicate that the output has closed. More...
 
bool pn_transport_quiesced (pn_transport_t *transport)
 Check if a transport has buffered data. More...
 
bool pn_transport_closed (pn_transport_t *transport)
 Check if a transport is closed. More...
 
pn_timestamp_t pn_transport_tick (pn_transport_t *transport, pn_timestamp_t now)
 Process any pending transport timer events. More...
 
uint64_t pn_transport_get_frames_output (const pn_transport_t *transport)
 Get the number of frames output by a transport. More...
 
uint64_t pn_transport_get_frames_input (const pn_transport_t *transport)
 Get the number of frames input by a transport. More...
 
pn_connection_t * pn_transport_connection (pn_transport_t *transport)
 Access the AMQP Connection associated with the transport. More...
 

Detailed Description

+

A network channel supporting an AMQP connection.

Macro Definition Documentation

- - -
#define PN_TRACE_DRV   (4)
-
-

Log driver related events, e.g. initialization, end of stream, etc.

- -
-
- -
-
- - - +
#define PN_TRACE_FRM   (2)#define PN_TRACE_DRV
-

Log frames into/out of the transport.

-
-
- -
-
- - - - -
#define PN_TRACE_OFF   (0)
-
-

Turn logging off entirely.

- -
-
- -
-
- - - - -
#define PN_TRACE_RAW   (1)
-
-

Log raw binary data into/out of the transport.

+

Log driver related events, e.g.

+

initialization, end of stream, etc.

@@ -289,30 +306,19 @@ Functions
-

Holds the trace flags for an AMQP transport.

+ +

Holds the trace flags for an AMQP transport.

The trace flags for an AMQP transport control what sort of information is logged by an AMQP transport. The following bits can be set:

- -
-
- - - - -
typedef void(* pn_tracer_t) (pn_transport_t *transport, const char *message)
-
-

Callback for customizing logging behaviour.

- -
-
@@ -322,18 +328,19 @@ Functions
-

An AMQP Transport object.

+ +

An AMQP Transport object.

A pn_transport_t encapsulates the transport related state of all AMQP endpoint objects associated with a physical network connection at a given point in time.

Function Documentation

- +
- + @@ -341,8 +348,10 @@ Functions
PN_EXTERN pn_transport_t* pn_transport pn_transport_t* pn_transport ( void  )
-

Factory for creating a transport. A transport is used by a connection to interface with the network. There can only be one connection associated with a transport. See pn_transport_bind().

-

Initially a transport is configured to be a client transport. Use pn_transport_set_server() to configure the transport as a server transport.

+ +

Factory for creating a transport.

+

A transport is used by a connection to interface with the network. There can only be one connection associated with a transport. See pn_transport_bind().

+

Initially a transport is configured to be a client transport. Use pn_transport_set_server() to configure the transport as a server transport.

A client transport initiates outgoing connections.

A client transport must be configured with the protocol layers to use and cannot configure itself automatically.

A server transport accepts incoming connections. It can automatically configure itself to include the various protocol layers depending on the incoming protocol headers.

@@ -350,12 +359,12 @@ Functions
- +
- + @@ -363,7 +372,8 @@ Functions
PN_EXTERN pn_record_t* pn_transport_attachments pn_record_t* pn_transport_attachments ( pn_transport_t *  transport)
-

Get the attachments that are associated with a transport object.

+ +

Get the attachments that are associated with a transport object.

Parameters
@@ -374,12 +384,12 @@ Functions - +
[in]transportthe transport whose attachments are to be returned.
- + @@ -397,17 +407,18 @@ Functions
PN_EXTERN int pn_transport_bind int pn_transport_bind ( pn_transport_t *  transport,
-

Binds the transport to an AMQP connection.

+ +

Binds the transport to an AMQP connection.

Returns
an error code, or 0 on success
- +
- + @@ -415,8 +426,9 @@ Functions
PN_EXTERN ssize_t pn_transport_capacity ssize_t pn_transport_capacity ( pn_transport_t *  transport)
-

Get the amount of free space for input following the transport's tail pointer.

-

If the engine is in an exceptional state such as encountering an error condition or reaching the end of stream state, a negative value will be returned indicating the condition. If an error is indicated, futher details can be obtained from pn_transport_error. Calls to pn_transport_process may alter the value of this pointer. See pn_transport_process for details.

+ +

Get the amount of free space for input following the transport's tail pointer.

+

If the engine is in an exceptional state such as encountering an error condition or reaching the end of stream state, a negative value will be returned indicating the condition. If an error is indicated, futher details can be obtained from pn_transport_error. Calls to pn_transport_process may alter the value of this pointer. See pn_transport_process for details.

Parameters
@@ -427,12 +439,12 @@ Functions - +
[in]transportthe transport
- + @@ -440,7 +452,8 @@ Functions
PN_EXTERN int pn_transport_close_head int pn_transport_close_head ( pn_transport_t *  transport)
-

Indicate that the output has closed.

+ +

Indicate that the output has closed.

This tells the transport that no more output will be popped.

Parameters
@@ -452,12 +465,12 @@ Functions - +
- + @@ -465,7 +478,8 @@ Functions
PN_EXTERN int pn_transport_close_tail int pn_transport_close_tail ( pn_transport_t *  transport)
-

Indicate that the input has reached End Of Stream (EOS).

+ +

Indicate that the input has reached End Of Stream (EOS).

This tells the transport that no more input will be forthcoming.

Parameters
@@ -477,12 +491,12 @@ Functions - +
- + @@ -490,8 +504,9 @@ Functions
PN_EXTERN bool pn_transport_closed bool pn_transport_closed ( pn_transport_t *  transport)
-

Check if a transport is closed.

-

A transport is defined to be closed when both the tail and the head are closed. In other words, when both pn_transport_capacity() < 0 and pn_transport_pending() < 0.

+ +

Check if a transport is closed.

+

A transport is defined to be closed when both the tail and the head are closed. In other words, when both pn_transport_capacity() < 0 and pn_transport_pending() < 0.

Parameters
@@ -502,12 +517,12 @@ Functions - +
[in]transporta transport object
- + @@ -515,7 +530,8 @@ Functions
PN_EXTERN pn_condition_t* pn_transport_condition pn_condition_t* pn_transport_condition ( pn_transport_t *  transport)
-

Get additional information about the condition of the transport.

+ +

Get additional information about the condition of the transport.

When a PN_TRANSPORT_ERROR event occurs, this operation can be used to access the details of the error condtion.

The pointer returned by this operation is valid until the transport object is freed.

Parameters
@@ -525,15 +541,16 @@ Functions
Returns
the transport's condition object
- +
Examples:
broker.c, receive.c, and send.c.
+
- +
- + @@ -541,7 +558,8 @@ Functions
PN_EXTERN pn_connection_t* pn_transport_connection pn_connection_t* pn_transport_connection ( pn_transport_t *  transport)
-

Access the AMQP Connection associated with the transport.

+ +

Access the AMQP Connection associated with the transport.

Parameters
@@ -552,12 +570,12 @@ Functions - +
[in]transporta transport object
- + @@ -565,16 +583,16 @@ Functions
PN_EXTERN pn_error_t* pn_transport_error pn_error_t* pn_transport_error ( pn_transport_t *  transport)
-
Deprecated:
+
D --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org For additional commands, e-mail: commits-help@qpid.apache.org