Classes
class	AmqpPerformativeEnvelopePool

class	EmptyEnvelope
	An empty incoming AMQP envelope that is used for signalling that an empty AMQP frame was read. More...

class	HeaderEnvelope
	Frame object that carries an AMQP Performative. More...

interface	IAttachments
	Attachments API used to provide additional state data to live alongside specific Proton AMQP resources. More...

interface	IConnection
	Represents an AMQP Connection which is owned by a single engine instance. More...

interface	IDeliveryTagGenerator
	Delivery tag generators can be assigned to sender links in order to allow the link to automatically assign a transfer tag to each outbound delivery. Depending on the Sender different tag generators can operate in a fashion that is most efficient for that link such as caching tags for links that will produce a large number of messages to avoid GC overhead, while for other links simpler generator types could be used. More...

interface	IEndpoint
	Represents an AMQP Connection which is owned by a single engine instance. More...

interface	IEngine
	Defines an AMQP Protocol Engine interface that should be used to implement an AMQP Engine. More...

interface	IEngineConfiguration
	Configuration options for the Engine. More...

interface	IEngineFactory
	Interface used to define the basic mechanisms for creating Engine instances. More...

interface	IEngineHandler
	Handler of engine events that is queued into the events pipeline. More...

interface	IEngineHandlerContext
	Context object that is provided to the engine handler APIs to allow for forwarding of events to the next handler or other updates. More...

interface	IEnginePipeline
	The engine pipeline contains a list of handlers that deal with incoming and outgoing AMQP frames such as logging and encoders and decoders. More...

interface	IEngineSaslDriver

interface	IIncomingDelivery
	Represents an incoming delivery that is received by a local receiver from a remote sender on an open link. More...

interface	ILink
	Base API for all AMQP Sender and Receiver links. More...

interface	ILinkCreditState
	Interface that defines an object that captures the current link credit state. More...

class	IncomingAmqpEnvelope
	Frame object that carries an AMQP Performative. More...

interface	IOutgoingDelivery
	Represents an outgoing delivery that is sent from a local sender to a remote receiver on an open link. More...

interface	IReceiver
	AMQP Receiver link resource. More...

interface	ISender
	AMQP Sender link resource. More...

interface	ISession
	The engine pipeline contains a list of handlers that deal with incoming and outgoing AMQP frames such as logging and encoders and decoders. More...

interface	ITransaction
	A Transaction object that hold information and context for a single Transaction. More...

interface	ITransactionController
	Transaction Controller link that implements the mechanics of declaring and discharging AMQP transactions. A transaction controller is typically used at the client side of an AMQP link to create transaction instances which the client application will enlist its incoming and outgoing deliveries into. More...

interface	ITransactionManager
	Transaction Manager endpoint that implements the mechanics of handling the declaration of and the requested discharge of AMQP transactions. Typically an AMQP server instance will host the transaction management services that are used by client resources to declare and discharge transaction and handle the associated of deliveries that are enlisted in active transactions. More...

class	LinkStateExtension

class	OutgoingAmqpEnvelope
	Frame object that carries an AMQP Performative. More...

class	PerformativeEnvelope
	Base class for envelope types that travel through the engine. More...

class	SaslEnvelope
	Frame object that carries an AMQP Performative. More...

Enumerations
enum	ConnectionState { Idle , Active , Closed }
	Enumerates the possible states that the Proton AMQP connection can occupy. More...

enum	DischargeState { None , Commit , Rollback }
	Provides a state value for a Transaction instance. More...

enum	EngineSaslState { Idle , Authenticating , Authenticated , AuthenticationFailed , None }
	The SASL driver state used to determine at what point the current SASL negotiation process is currently in. If the state is 'none' then no SASL negotiations will be performed. More...

enum	EngineState { Idle , Starting , Started , Failed , ShuttingDown , Shutdown }
	Enumerates the possible states that the Proton AMQP engine can occupy. More...

enum	LinkState { Idle , Active , Detached , Closed }
	Enumerates the possible states that the Proton AMQP link can occupy. More...

enum	SessionState { Idle , Active , Closed }
	Represents the state of an AMQP Session. More...

enum	TransactionState { Idle , Declaring , Declared , Discharging , Discharged , DeclareFailed , DischargeFailed }
	A Transaction state enumeration that provides insight into what the current state of a transaction is. More...

Enumeration Type Documentation

◆ ConnectionState

enum Apache.Qpid.Proton.Engine.ConnectionState

Enumerates the possible states that the Proton AMQP connection can occupy.

Enumerator
Idle	Indicates that the targeted end of the Connection (local or remote) has not yet been opened.
Active	Indicates that the targeted end of the Connection (local or remote) is currently open.
Closed	Indicates that the targeted end of the Connection (local or remote) has been closed.

◆ DischargeState

enum Apache.Qpid.Proton.Engine.DischargeState

Provides a state value for a Transaction instance.

Enumerator
None	The transaction is live and has not yet been committed or rolled back.
Commit	The transaction has been committed and cannot be rolled back.
Rollback	The transaction has been rolled back and cannot be committed.

◆ EngineSaslState

enum Apache.Qpid.Proton.Engine.EngineSaslState

The SASL driver state used to determine at what point the current SASL negotiation process is currently in. If the state is 'none' then no SASL negotiations will be performed.

Enumerator
Idle	Engine not started, SASL context can be configured.
Authenticating	Engine started and set configuration in use.
Authenticated	Authentication succeeded.
AuthenticationFailed	Authentication failed.
None	No authentication layer configured.

◆ EngineState

enum Apache.Qpid.Proton.Engine.EngineState

Enumerates the possible states that the Proton AMQP engine can occupy.

Enumerator
Idle	The engine has not yet been started and is safe to configure.
Starting	Indicates the engine is in the starting phase and configuration is safe to use now.
Started	The engine has been started and no changes to configuration are permissible.
Failed	The engine has encountered an error and is no longer usable.
ShuttingDown	Engine is shutting down and all pending work should be completed.
Shutdown	The engine has been shutdown and can no longer be used.

◆ LinkState

enum Apache.Qpid.Proton.Engine.LinkState

Enumerates the possible states that the Proton AMQP link can occupy.

Enumerator
Idle	Indicates that the targeted end of the Link (local or remote) has not yet been opened.
Active	Indicates that the targeted end of the Link (local or remote) is currently open.
Detached	Indicates that the targeted end of the Link (local or remote) has been detached.
Closed	Indicates that the targeted end of the Link (local or remote) has been closed.

◆ SessionState

enum Apache.Qpid.Proton.Engine.SessionState

Represents the state of an AMQP Session.

Enumerator
Idle	Indicates that the targeted end of the Session (local or remote) has not yet been opened.
Active	Indicates that the targeted end of the Session (local or remote) is currently open.
Closed	Indicates that the targeted end of the Session (local or remote) has been closed.

◆ TransactionState

enum Apache.Qpid.Proton.Engine.TransactionState

A Transaction state enumeration that provides insight into what the current state of a transaction is.

Enumerator
Idle	A Transaction is considered IDLE until the transaction manager responds that it has been declared successfully and an transaction Id has been assigned.
Declaring	A Transaction is considered declaring once a Declare command has been sent to the remote but before any declared response has been received which assigns the transaction Id value.
Declared	A Transaction is considered declared once the TransactionManager has responded in the affirmative and assigned a transaction Id.
Discharging	A is considered to b discharging once a Discharge command has been sent to the remote but before any response has been received indicating the outcome of the attempted discharge.
Discharged	A Transaction is considered discharged once a discharge has been requested and the transaction manager has responded in the affirmative that the request has been honored.
DeclareFailed	A Transaction is considered failed if the transaction manager responds with an error to the declaration action.
DischargeFailed	A Transaction is considered failed in the transaction manager responds with an error to the discharge action.

Classes

Enumerations