Base endpoint class that provides some of the most common endpoint implementations and some API for internal use when dealing with events. More...

Inheritance diagram for Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >:

Public Member Functions
	ProtonEndpoint (ProtonEngine engine)
	Creates a new instance of this endpoint implementation which is owned by the provided engine instance.

T	OpenHandler (Action< T > openHandler)
	Sets a Action for when an AMQP Open frame is received from the remote peer. Used to process remotely initiated Connections. Locally initiated sessions have their own Action invoked instead. This method is typically used by servers to listen for the remote peer to open its endpoint, while a client would listen for the server to open its end of the endpoint once a local open has been performed. Typically used by clients as servers will typically listen to some parent resource event handler to determine if the remote is initiating a resource open.

T	CloseHandler (Action< T > closeHandler)
	Sets a EventHandler for when an AMQP closing frame is received from the remote peer.

T	LocalOpenHandler (Action< T > localOpenHandler)
	Sets a Action for when an this endpoint is opened locally via a call to Open. Typically used by clients for logging or other state update event processing. Clients should not perform any blocking calls within this context. It is an error for the handler to throw an exception and the outcome of doing so is undefined. Typically used by clients as servers will typically listen to some parent resource event handler to determine if the remote is initiating a resource open.

T	LocalCloseHandler (Action< T > localCloseHandler)
	Sets a Action for when an this endpoint is closed locally via a call to Close. Typically used by clients for logging or other state update event processing. Clients should not perform any blocking calls within this context. It is an error for the handler to throw an exception and the outcome of doing so is undefined.

T	EngineShutdownHandler (Action< IEngine > shutdownHandler)
	Sets an Action that is invoked when the engine that supports this endpoint is shutdown which indicates a desire to terminate all engine operations. Any endpoint that has been both locally and remotely closed will not receive this event as it will no longer be tracked by the parent its parent endpoint. A typical use of this event would be from a locally closed endpoint that is awaiting response from the remote. If this event fires then there will never be a remote response to any pending operations and the client or server instance should react accordingly to clean up any related resources etc.

T	Close ()
	Close the end point locally and send the closing performative immediately if possible or holds it until the Connection / Engine state allows it. If the engine encounters an error writing the performative or the engine is in a failed state from a previous error then this method will throw an exception. If the engine has been shutdown then this method will close out the local end of the endpoint and clean up any local resources before returning normally.

T	Open ()
	Open the end point locally, sending the Open performative immediately if possible or holding it until SASL negotiations or the AMQP header exchange and other required performative exchanges has completed. The endpoint will signal any registered handler of the remote opening the endpoint once the remote performative that signals open completion arrives.

Protected Attributes
readonly ProtonEngine	engine

Properties
virtual IEngine	Engine `[get]`
	Provides access to the engine instance that owns the resources of this endpoint and its parent.

IAttachments	Attachments `[get]`
	Access the attachments instance that is associated with this resource where the application can store data relevant to the endpoint for later use.

object	LinkedResource `[get, set]`
	Allows the endpoint to have some user defined resource linked to it which can be used to store application state data or other associated object instances with this endpoint.

virtual ErrorCondition	ErrorCondition `[get, set]`
	Provides access to the error condition that should be applied to the AMQP frame that closes or ends this endpoint when the close method is called be the user. Setting this value after closing the endpoint has no effect.

virtual ErrorCondition	RemoteErrorCondition `[get, set]`
	If the remote has closed this endpoint and provided an ErrorCondition as part of the closing AMQP performative then this method will return it.

bool	IsLocallyOpen `[get]`
	Returns true if the endpoint open was previously called and the close method has not yet been invoked. This only reflects the state on the local end and the user should also check the remote state.

bool	IsLocallyClosed `[get]`
	Returns true if the endpoint having been previously locally opened is now closed due to a call the the close method. This does not reflect the state of the remote endpoint and that should be checked separately.

bool	IsRemotelyOpen `[get]`
	Returns true if this endpoint is currently remotely open meaning that the AMQP performative that completes the open phase of this endpoint's lifetime has arrived but the performative that closes it has not.

bool	IsRemotelyClosed `[get]`
	Returns true if this endpoint is currently remotely closed meaning that the AMQP performative that completes the close phase of this endpoint's lifetime has arrived.

Symbol[]	OfferedCapabilities `[get, set]`
	Access the capabilities to be offered on to the remote when this endpoint is opened. The offered capabilities value can only be modified prior to a call to open, once the endpoint has been opened locally an error will be thrown if this method is called.

Symbol[]	DesiredCapabilities `[get, set]`
	Access the capabilities that are desired on to the remote when this endpoint is opened. The desired capabilities value can only be modified prior to a call to open, once the endpoint has been opened locally an error will be thrown if this method is called.

Symbol[]	RemoteOfferedCapabilities `[get]`
	The capabilities offered by the remote when it opened its end of the endpoint.

Symbol[]	RemoteDesiredCapabilities `[get]`
	The capabilities desired by the remote when it opened its end of the endpoint.

IReadOnlyDictionary< Symbol, object >	Properties `[get, set]`
	Access the properties that are conveyed to the remote when this endpoint is opened. The properties value can only be modified prior to a call to open, once the endpoint has been opened locally an error will be thrown if this method is called.

IReadOnlyDictionary< Symbol, object >	RemoteProperties `[get]`
	The properties sent by the remote when it opened its end of this endpoint.

Properties inherited from Apache.Qpid.Proton.Engine.IEndpoint< T >

Detailed Description

Base endpoint class that provides some of the most common endpoint implementations and some API for internal use when dealing with events.

Type Constraints

T

:

IEndpoint<T>

Constructor & Destructor Documentation

◆ ProtonEndpoint()

Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >.ProtonEndpoint ( ProtonEngine engine )

inline

Creates a new instance of this endpoint implementation which is owned by the provided engine instance.

Parameters

engine The engine that owns this endpoint instance.

Member Function Documentation

◆ Close()

T Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >.Close ( )

abstract

Close the end point locally and send the closing performative immediately if possible or holds it until the Connection / Engine state allows it. If the engine encounters an error writing the performative or the engine is in a failed state from a previous error then this method will throw an exception. If the engine has been shutdown then this method will close out the local end of the endpoint and clean up any local resources before returning normally.

Returns: This endpoint instance.

Exceptions

EngineStateException If the engine state is already failed or shutdown

Implements Apache.Qpid.Proton.Engine.IEndpoint< T >.

◆ CloseHandler()

T Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >.CloseHandler ( Action< T > localCloseHandler )

inline

Sets a EventHandler for when an AMQP closing frame is received from the remote peer.

Parameters

localCloseHandler The handler to invoke when the event occurs

Returns: This Endpoint instance.

Implements Apache.Qpid.Proton.Engine.IEndpoint< T >.

◆ EngineShutdownHandler()

T Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >.EngineShutdownHandler ( Action< IEngine > shutdownHandler )

inline

Sets an Action that is invoked when the engine that supports this endpoint is shutdown which indicates a desire to terminate all engine operations. Any endpoint that has been both locally and remotely closed will not receive this event as it will no longer be tracked by the parent its parent endpoint. A typical use of this event would be from a locally closed endpoint that is awaiting response from the remote. If this event fires then there will never be a remote response to any pending operations and the client or server instance should react accordingly to clean up any related resources etc.

Parameters

shutdownHandler The handler to invoke when the event occurs

Returns: This Endpoint instance.

Implements Apache.Qpid.Proton.Engine.IEndpoint< T >.

◆ LocalCloseHandler()

T Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >.LocalCloseHandler ( Action< T > localCloseHandler )

inline

Sets a Action for when an this endpoint is closed locally via a call to Close. Typically used by clients for logging or other state update event processing. Clients should not perform any blocking calls within this context. It is an error for the handler to throw an exception and the outcome of doing so is undefined.

Parameters

localCloseHandler The handler to invoke when the event occurs

Returns: This Endpoint instance.

Implements Apache.Qpid.Proton.Engine.IEndpoint< T >.

◆ LocalOpenHandler()

T Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >.LocalOpenHandler ( Action< T > localOpenHandler )

inline

Sets a Action for when an this endpoint is opened locally via a call to Open. Typically used by clients for logging or other state update event processing. Clients should not perform any blocking calls within this context. It is an error for the handler to throw an exception and the outcome of doing so is undefined. Typically used by clients as servers will typically listen to some parent resource event handler to determine if the remote is initiating a resource open.

Parameters

localOpenHandler The handler to invoke when the event occurs

Returns: This Endpoint instance.

Implements Apache.Qpid.Proton.Engine.IEndpoint< T >.

◆ Open()

T Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >.Open ( )

abstract

Open the end point locally, sending the Open performative immediately if possible or holding it until SASL negotiations or the AMQP header exchange and other required performative exchanges has completed. The endpoint will signal any registered handler of the remote opening the endpoint once the remote performative that signals open completion arrives.

Returns: This endpoint instance.

Exceptions

EngineStateException If the engine state is already failed or shutdown

Implements Apache.Qpid.Proton.Engine.IEndpoint< T >.

◆ OpenHandler()

T Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >.OpenHandler ( Action< T > localOpenHandler )

inline

Sets a Action for when an AMQP Open frame is received from the remote peer. Used to process remotely initiated Connections. Locally initiated sessions have their own Action invoked instead. This method is typically used by servers to listen for the remote peer to open its endpoint, while a client would listen for the server to open its end of the endpoint once a local open has been performed. Typically used by clients as servers will typically listen to some parent resource event handler to determine if the remote is initiating a resource open.

Parameters

localOpenHandler The handler to invoke when the event occurs

Returns: This Endpoint instance.

Implements Apache.Qpid.Proton.Engine.IEndpoint< T >.

Property Documentation

◆ Attachments

IAttachments Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >.Attachments

get

Access the attachments instance that is associated with this resource where the application can store data relevant to the endpoint for later use.

Implements Apache.Qpid.Proton.Engine.IEndpoint< T >.

◆ DesiredCapabilities

Symbol [] Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >.DesiredCapabilities

getsetabstract

Access the capabilities that are desired on to the remote when this endpoint is opened. The desired capabilities value can only be modified prior to a call to open, once the endpoint has been opened locally an error will be thrown if this method is called.

Implements Apache.Qpid.Proton.Engine.IEndpoint< T >.

◆ Engine

virtual IEngine Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >.Engine

get

Provides access to the engine instance that owns the resources of this endpoint and its parent.

Implements Apache.Qpid.Proton.Engine.IEndpoint< T >.

◆ ErrorCondition

virtual ErrorCondition Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >.ErrorCondition

getset

Provides access to the error condition that should be applied to the AMQP frame that closes or ends this endpoint when the close method is called be the user. Setting this value after closing the endpoint has no effect.

Implements Apache.Qpid.Proton.Engine.IEndpoint< T >.

◆ IsLocallyClosed

bool Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >.IsLocallyClosed

getabstract

Returns true if the endpoint having been previously locally opened is now closed due to a call the the close method. This does not reflect the state of the remote endpoint and that should be checked separately.

Implements Apache.Qpid.Proton.Engine.IEndpoint< T >.

◆ IsLocallyOpen

bool Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >.IsLocallyOpen

getabstract

Returns true if the endpoint open was previously called and the close method has not yet been invoked. This only reflects the state on the local end and the user should also check the remote state.

Implements Apache.Qpid.Proton.Engine.IEndpoint< T >.

◆ IsRemotelyClosed

bool Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >.IsRemotelyClosed

getabstract

Returns true if this endpoint is currently remotely closed meaning that the AMQP performative that completes the close phase of this endpoint's lifetime has arrived.

Implements Apache.Qpid.Proton.Engine.IEndpoint< T >.

◆ IsRemotelyOpen

bool Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >.IsRemotelyOpen

getabstract

Returns true if this endpoint is currently remotely open meaning that the AMQP performative that completes the open phase of this endpoint's lifetime has arrived but the performative that closes it has not.

Implements Apache.Qpid.Proton.Engine.IEndpoint< T >.

◆ LinkedResource

object Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >.LinkedResource

getset

Allows the endpoint to have some user defined resource linked to it which can be used to store application state data or other associated object instances with this endpoint.

Implements Apache.Qpid.Proton.Engine.IEndpoint< T >.

◆ OfferedCapabilities

Symbol [] Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >.OfferedCapabilities

getsetabstract

Access the capabilities to be offered on to the remote when this endpoint is opened. The offered capabilities value can only be modified prior to a call to open, once the endpoint has been opened locally an error will be thrown if this method is called.

Implements Apache.Qpid.Proton.Engine.IEndpoint< T >.

◆ Properties

IReadOnlyDictionary<Symbol, object> Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >.Properties

getsetabstract

Access the properties that are conveyed to the remote when this endpoint is opened. The properties value can only be modified prior to a call to open, once the endpoint has been opened locally an error will be thrown if this method is called.

Implements Apache.Qpid.Proton.Engine.IEndpoint< T >.