[−][src]Crate qpid_proton_sys
Structs
Enums
pn_event_type_t | |
pn_log_level_t | |
pn_log_subsystem_t | |
pn_ssl_mode_t |
Functions
pn_bytes⚠ | |
pn_condition_get_description⚠ | |
pn_condition_get_name⚠ | |
pn_connection⚠ | Factory to construct a new Connection. |
pn_connection_close⚠ | Close a connection. Once this operation has completed, the PN_LOCAL_CLOSED state flag will be set. This may be called without calling pn_connection_open, in this case it is equivalent to calling pn_connection_open followed by pn_connection_close. |
pn_connection_open⚠ | Open a connection. Once this operation has completed, the PN_LOCAL_ACTIVE state flag will be set. |
pn_connection_set_container⚠ | Set the AMQP Container name advertised by a connection object. |
pn_connection_set_hostname⚠ | |
pn_connection_set_password⚠ | |
pn_connection_set_user⚠ | |
pn_data_enter⚠ | |
pn_data_exit⚠ | |
pn_data_put_int⚠ | |
pn_data_put_map⚠ | |
pn_data_put_string⚠ | |
pn_delivery⚠ | |
pn_delivery_link⚠ | Get the parent link for a delivery object. |
pn_delivery_pending⚠ | Get the amount of pending message data for a delivery. |
pn_delivery_readable⚠ | Check if a delivery is readable. A delivery is considered readable if it is the current delivery on an incoming link. |
pn_delivery_remote_state⚠ | |
pn_delivery_settle⚠ | Settle a delivery. A settled delivery can never be used again. |
pn_delivery_update⚠ | Update the disposition of a delivery. When update is invoked the updated disposition of the delivery will be communicated to the peer. |
pn_dtag⚠ | |
pn_error_set⚠ | |
pn_error_text⚠ | |
pn_event_batch_next⚠ | |
pn_event_connection⚠ | |
pn_event_delivery⚠ | |
pn_event_link⚠ | |
pn_event_session⚠ | |
pn_event_type⚠ | |
pn_link_advance⚠ | Advance the current delivery of a link to the next delivery on the link. For sending links this operation is used to finish sending message data for the current outgoing delivery and move on to the next outgoing delivery (if any). For receiving links, this operation is used to finish accessing message data from the current incoming delivery and move on to the next incoming delivery (if any). Each link maintains a sequence of deliveries in the order they were created, along with a pointer to the current delivery. The pn_link_advance operation will modify the current delivery on the link to point to the next delivery in the sequence. If there is no next delivery in the sequence, the current delivery will be set to NULL. This operation will return true if invoking it caused the value of the current delivery to change, even if it was set to NULL. |
pn_link_credit⚠ | Get the credit balance for a link. Links use a credit based flow control scheme. Every receiver maintains a credit balance that corresponds to the number of deliveries that the receiver can accept at any given moment. As more capacity becomes available at the receiver (see pn_link_flow), it adds credit to this balance and communicates the new balance to the sender. Whenever a delivery is sent/received, the credit balance maintained by the link is decremented by one. Once the credit balance at the sender reaches zero, the sender must pause sending until more credit is obtained from the receiver. Note that a sending link may still be used to send deliveries even if pn_link_credit reaches zero, however those deliveries will end up being buffered by the link until enough credit is obtained from the receiver to send them over the wire. In this case the balance reported by pn_link_credit will go negative. |
pn_link_flow⚠ | Grant credit for incoming deliveries on a receiver. |
pn_link_open⚠ | Open a link. Once this operation has completed, the PN_LOCAL_ACTIVE state flag will be set. |
pn_link_recv⚠ | Receive message data for the current delivery on a link. Use pn_delivery_pending on the current delivery to figure out how much buffer space is needed. Note that the link API can be used to stream large messages across the network, so just because there is no data to read does not imply the message is complete. To ensure the entirety of the message data has been read, either invoke pn_link_recv until PN_EOS is returned, or verify that (!pn_delivery_partial(d) && !pn_delivery_aborted(d) && pn_delivery_pending(d)==0) |
pn_link_send⚠ | Send message data for the current delivery on a link. |
pn_link_source⚠ | Access the locally defined source definition for a link. The pointer returned by this operation is valid until the link object is freed. |
pn_link_target⚠ | Access the locally defined target definition for a link. The pointer returned by this operation is valid until the link object is freed. |
pn_logger_set_mask⚠ | |
pn_message⚠ | Construct a new pn_message_t. Every message that is constructed must be freed using pn_message_free(). |
pn_message_body⚠ | Get and set the body of a message. This operation returns a pointer to a pn_data_t representing the body of a message. The pointer is valid until the message is freed and may be used to both access and modify the content of the message body. |
pn_message_clear⚠ | Clears the content of a pn_message_t. When pn_message_clear returns, the supplied pn_message_t will be emptied of all content and effectively returned to the same state as if it was just created. |
pn_message_decode⚠ | Decode/load message content from AMQP formatted binary data. Upon invoking this operation, any existing message content will be cleared and replaced with the content from the provided binary data. |
pn_message_encode⚠ | Encode a message as AMQP formatted binary data. If the buffer space provided is insufficient to store the content held in the message, the operation will fail and return a PN_OVERFLOW error code. |
pn_message_error⚠ | Free a previously constructed pn_message_t. |
pn_message_free⚠ | Free a previously constructed pn_message_t. |
pn_message_id⚠ | Get/set the id for a message. The message id provides a globally unique identifier for a message. A message id can be an a string, an unsigned long, a uuid or a binary value. This operation returns a pointer to a pn_data_t that can be used to access and/or modify the value of the message id. The pointer is valid until the message is freed. See pn_data_t for details on how to get/set the value. |
pn_message_send⚠ | Encode and send a message on a sender link. Performs the following steps: call pn_message_encode2() to encode the message to a buffer call pn_link_send() to send the encoded message bytes call pn_link_advance() to indicate the message is complete Note: you must create a delivery for the message before calling pn_message_send() see pn_delivery() |
pn_proactor⚠ | Create a proactor. Must be freed with pn_proactor_free() |
pn_proactor_addr⚠ | Format a host:port address string for pn_proactor_connect() or pn_proactor_listen() |
pn_proactor_connect2⚠ | Free the proactor. Abort open connections/listeners, clean up all resources. |
pn_proactor_done⚠ | Call when finished handling a batch of events. Must be called exactly once to match each call to pn_proactor_wait(). |
pn_proactor_free⚠ | Free the proactor. Abort open connections/listeners, clean up all resources. |
pn_proactor_wait⚠ | Wait until there are Proactor events to handle. You must call pn_proactor_done() when you are finished with the batch, you must not use the batch pointer after calling pn_proactor_done(). Normally it is most efficient to handle the entire batch in the calling thread and then call pn_proactor_done(), but see pn_proactor_done() for more options. pn_proactor_get() is a non-blocking version of this call. |
pn_receiver⚠ | Construct a new receiver on a session. Each receiving link between two AMQP containers must be uniquely named. Note that this uniqueness cannot be enforced at the API level, so some consideration should be taken in choosing link names. |
pn_sasl⚠ | Construct an Authentication and Security Layer object. This will return the SASL layer object for the supplied transport object. If there is currently no SASL layer one will be created. On the client side of an AMQP connection this will have the effect of ensuring that the AMQP SASL layer is used for that connection. |
pn_sasl_allowed_mechs⚠ | SASL mechanisms that are to be considered for authentication. This can be used on either the client or the server to restrict the SASL mechanisms that may be used to the mechanisms on the list. |
pn_sasl_set_allow_insecure_mechs⚠ | |
pn_sender⚠ | |
pn_session⚠ | Factory for creating a new session on a given connection object. Creates a new session object and adds it to the set of sessions maintained by the connection object. |
pn_session_close⚠ | Close a session. Once this operation has completed, the PN_LOCAL_CLOSED state flag will be set. This may be called without calling pn_session_open, in this case it is equivalent to calling pn_session_open followed by pn_session_close. |
pn_session_free⚠ | Free a session object. When a session is freed it will no longer be retained by the connection once any internal references to the session are no longer needed. Freeing a session will free all links on that session and settle any deliveries on those links. |
pn_session_open⚠ | Open a session. Once this operation has completed, the PN_LOCAL_ACTIVE state flag will be set. |
pn_session_remote_condition⚠ | Boolean to allow use of clear text authentication mechanisms. By default the SASL layer is configured not to allow mechanisms that disclose the clear text of the password over an unencrypted AMQP connection. This specifically will disallow the use of the PLAIN mechanism without using SSL encryption. This default is to avoid disclosing password information accidentally over an insecure network. If you actually wish to use a clear text password unencrypted then you can use this API to set allow_insecure_mechs to true. |
pn_ssl⚠ | |
pn_ssl_domain⚠ | |
pn_ssl_get_remote_subject⚠ | |
pn_ssl_init⚠ | |
pn_ssl_set_peer_hostname⚠ | |
pn_terminus_set_address⚠ | |
pn_transport⚠ | |
pn_transport_condition⚠ | |
pn_transport_logger⚠ | |
pn_transport_require_auth⚠ | |
pn_transport_require_encryption⚠ |