Implements the stream sender using a stateful current outgoing message that prevents any sends other than to the current message until the current is completed. More...

Inheritance diagram for Apache.Qpid.Proton.Client.Implementation.ClientStreamSender:

Public Member Functions
IStreamTracker	Send< T > (IMessage< T > message, IDictionary< string, object > deliveryAnnotations=null)
	If no streaming send has been initiated and not yet completed then this method will send the given message immediately if there is credit available or blocks if the link has not yet been granted credit. If a send timeout has been configured then this method will throw a timed out error after that if the message cannot be sent.

IStreamTracker	TrySend< T > (IMessage< T > message, IDictionary< string, object > deliveryAnnotations=null)
	If no streaming send has been initiated and not yet completed then this method will send the given message if credit is available or returns null if no credit has been granted to the link at the time of the send attempt.

Task< IStreamTracker >	SendAsync< T > (IMessage< T > message, IDictionary< string, object > deliveryAnnotations=null)
	If no streaming send has been initiated and not yet completed then this method will send the given message immediately if there is credit available or waits if the link has not yet been granted credit. If a send timeout has been configured then this method will fail the returned Task with a timed out error after that if the message cannot be sent. The returned Task will be completed once the message has been sent.

Task< IStreamTracker >	TrySendAsync< T > (IMessage< T > message, IDictionary< string, object > deliveryAnnotations=null)
	If no streaming send has been initiated and not yet completed then this method will send the given message if credit is available or completes the returned Task with null if no credit has been granted to the link at the time of the send attempt.

IStreamSenderMessage	BeginMessage (IDictionary< string, object > deliveryAnnotations=null)
	Creates and returns a new stream capable message that can be used by the caller to perform streaming sends of large message payload data. Only one streamed message can be active at a time so any successive calls to begin a new streaming message will throw an error to indicate that the previous instance has not yet been completed.

Task< IStreamSenderMessage >	BeginMessageAsync (IDictionary< string, object > deliveryAnnotations=null)
	Creates and returns a new stream capable message that can be used by the caller to perform streaming sends of large message payload data. Only one streamed message can be active at a time so any successive calls to begin a new streaming message will throw an error to indicate that the previous instance has not yet been completed.

Public Member Functions inherited from Apache.Qpid.Proton.Client.Implementation.ClientLinkType< IStreamSender, Engine.ISender >
void	Close (IErrorCondition error=null)

Task< LinkType >	CloseAsync (IErrorCondition error=null)

void	Detach (IErrorCondition error=null)

Task< LinkType >	DetachAsync (IErrorCondition error=null)

void	Dispose ()

Public Member Functions inherited from Apache.Qpid.Proton.Client.ILink< IStreamSender >
void	Close (IErrorCondition error=null)
	Initiates a close of the link and awaits a response from the remote that indicates completion of the close operation. If the response from the remote exceeds the configure close timeout the method returns after cleaning up the link resources.

void	Detach (IErrorCondition error=null)
	Initiates a detach of the link and awaits a response from the remote that indicates completion of the detach operation. If the response from the remote exceeds the configure close timeout the method returns after cleaning up the link resources.

Task< Role >	CloseAsync (IErrorCondition error=null)
	Initiates a close of the link and a Task that allows the caller to await or poll for the response from the remote that indicates completion of the close operation. If the response from the remote exceeds the configure close timeout the sender will be cleaned up and the Task signalled indicating completion.

Task< Role >	DetachAsync (IErrorCondition error=null)
	Initiates a detach of the link and a Task that allows the caller to await or poll for the response from the remote that indicates completion of the detach operation. If the response from the remote exceeds the configure close timeout the sender will be cleaned up and the Task signalled indicating completion.

Additional Inherited Members
Protected Member Functions inherited from Apache.Qpid.Proton.Client.Implementation.ClientLinkType< IStreamSender, Engine.ISender >
virtual Task< LinkType >	DoCloseOrDetach (bool close, IErrorCondition error)

void	CheckClosedOrFailed ()

void	WaitForOpenToComplete ()

bool	NotClosedOrFailed< T > (TaskCompletionSource< T > request)

bool	NotClosedOrFailed< T > (TaskCompletionSource< T > request, ProtonLinkType sender)

Protected Attributes inherited from Apache.Qpid.Proton.Client.Implementation.ClientLinkType< IStreamSender, Engine.ISender >
readonly AtomicBoolean	closed

readonly ClientSession	session

ClientException	failureCause

readonly TaskCompletionSource< LinkType >	openFuture

readonly TaskCompletionSource< LinkType >	closeFuture

volatile ISource	remoteSource

volatile ITarget	remoteTarget

ProtonLinkType	protonLink

Properties inherited from Apache.Qpid.Proton.Client.Implementation.ClientLinkType< IStreamSender, Engine.ISender >
IClient	Client `[get]`

IConnection	Connection `[get]`

ISession	Session `[get]`

Task< LinkType >	OpenTask `[get]`

string	Address `[get]`

ISource	Source `[get]`

ITarget	Target `[get]`

IReadOnlyDictionary< string, object >	Properties `[get]`

IReadOnlyCollection< string >	OfferedCapabilities `[get]`

IReadOnlyCollection< string >	DesiredCapabilities `[get]`

Properties inherited from Apache.Qpid.Proton.Client.ILink< IStreamSender >
IClient	Client `[get]`
	Returns the parent client instance that hosts this link.

IConnection	Connection `[get]`
	Returns the parent connection instance that hosts this link.

ISession	Session `[get]`
	Returns the parent session instance that created this link.

string	Address `[get]`
	Returns the address that the link instance will send message objects to. The value returned from this method is controlled by the configuration that was used to create the link. If the link is configured as an anonymous link then this method returns null. If the link was created with the dynamic link methods then the method will return the dynamically created address once the remote has attached its end of the link link. Due to the need to await the remote peer to populate the dynamic address this method will block until the open of the link link has completed. If neither of the above is true then the address returned is the address passed to the original address value passed to one of the open link methods.

ISource	Source `[get]`
	Returns an immutable view of the remote Source object assigned to this link link. If the attach has not completed yet this method will block to await the attach response which carries the remote source.

ITarget	Target `[get]`
	Returns an immutable view of the remote Target object assigned to this link link. If the attach has not completed yet this method will block to await the attach response which carries the remote target.

IReadOnlyDictionary< string, object >	Properties `[get]`
	Returns the properties that the remote provided upon successfully opening the link. If the open has not completed yet this method will block to await the open response which carries the remote properties. If the remote provides no properties this method will return null.

IReadOnlyCollection< string >	OfferedCapabilities `[get]`
	Returns the offered capabilities that the remote provided upon successfully opening the link. If the open has not completed yet this method will block to await the open response which carries the remote offered capabilities. If the remote provides no offered capabilities this method will return null.

IReadOnlyCollection< string >	DesiredCapabilities `[get]`
	Returns the desired capabilities that the remote provided upon successfully opening the link. If the open has not completed yet this method will block to await the open response which carries the remote desired capabilities. If the remote provides no desired capabilities this method will return null.

Task< Role >	OpenTask `[get]`
	When a link is created and returned to the client application it may not be remotely opened yet and if the client needs to wait for completion of the open before proceeding the open task can be fetched and waited upon.

Detailed Description

Implements the stream sender using a stateful current outgoing message that prevents any sends other than to the current message until the current is completed.

Member Function Documentation

◆ BeginMessage()

IStreamSenderMessage Apache.Qpid.Proton.Client.Implementation.ClientStreamSender.BeginMessage ( IDictionary< string, object > deliveryAnnotations = null )

inline

Creates and returns a new stream capable message that can be used by the caller to perform streaming sends of large message payload data. Only one streamed message can be active at a time so any successive calls to begin a new streaming message will throw an error to indicate that the previous instance has not yet been completed.

Parameters

deliveryAnnotations The optional delivery annotations to transmit with the message

Returns: A new IStreamSenderMessage if no send is currently in progress

Implements Apache.Qpid.Proton.Client.IStreamSender.

◆ BeginMessageAsync()

Task< IStreamSenderMessage > Apache.Qpid.Proton.Client.Implementation.ClientStreamSender.BeginMessageAsync ( IDictionary< string, object > deliveryAnnotations = null )

inline

Creates and returns a new stream capable message that can be used by the caller to perform streaming sends of large message payload data. Only one streamed message can be active at a time so any successive calls to begin a new streaming message will throw an error to indicate that the previous instance has not yet been completed.

Parameters

deliveryAnnotations The optional delivery annotations to transmit with the message

Returns: A Task that returns new IStreamSenderMessage if no send is currently in progress

Implements Apache.Qpid.Proton.Client.IStreamSender.

◆ Send< T >()

IStreamTracker Apache.Qpid.Proton.Client.Implementation.ClientStreamSender.Send< T >	(	IMessage< T >	message,
		IDictionary< string, object >	deliveryAnnotations = `null`
	)

inline

If no streaming send has been initiated and not yet completed then this method will send the given message immediately if there is credit available or blocks if the link has not yet been granted credit. If a send timeout has been configured then this method will throw a timed out error after that if the message cannot be sent.

Template Parameters

T	The type that describes the message body

Parameters

message	The message object that will be sent
deliveryAnnotations	Optional delivery annotation to include with the message

Returns: A Tracker for the sent message

Implements Apache.Qpid.Proton.Client.IStreamSender.

◆ SendAsync< T >()

Task< IStreamTracker > Apache.Qpid.Proton.Client.Implementation.ClientStreamSender.SendAsync< T >	(	IMessage< T >	message,
		IDictionary< string, object >	deliveryAnnotations = `null`
	)

inline

If no streaming send has been initiated and not yet completed then this method will send the given message immediately if there is credit available or waits if the link has not yet been granted credit. If a send timeout has been configured then this method will fail the returned Task with a timed out error after that if the message cannot be sent. The returned Task will be completed once the message has been sent.

Template Parameters

T	The type that describes the message body

Parameters

message	The message object that will be sent
deliveryAnnotations	Optional delivery annotation to include with the message

Returns: A Task that is completed with a Tracker once the send completes

Implements Apache.Qpid.Proton.Client.IStreamSender.

◆ TrySend< T >()

IStreamTracker Apache.Qpid.Proton.Client.Implementation.ClientStreamSender.TrySend< T >	(	IMessage< T >	message,
		IDictionary< string, object >	deliveryAnnotations = `null`
	)

inline

If no streaming send has been initiated and not yet completed then this method will send the given message if credit is available or returns null if no credit has been granted to the link at the time of the send attempt.

Template Parameters

T	The type that describes the message body

Parameters

message	The message object that will be sent
deliveryAnnotations	Optional delivery annotation to include with the message

Returns: A Tracker for the sent message or null if no credit to send is available

Implements Apache.Qpid.Proton.Client.IStreamSender.

◆ TrySendAsync< T >()

Task< IStreamTracker > Apache.Qpid.Proton.Client.Implementation.ClientStreamSender.TrySendAsync< T >	(	IMessage< T >	message,
		IDictionary< string, object >	deliveryAnnotations = `null`
	)

inline

If no streaming send has been initiated and not yet completed then this method will send the given message if credit is available or completes the returned Task with null if no credit has been granted to the link at the time of the send attempt.

Template Parameters

T	The type that describes the message body

Parameters

message	The message object that will be sent
deliveryAnnotations	Optional delivery annotation to include with the message

Returns: A Task that provides a tracker if the send completes or null if no credit

Implements Apache.Qpid.Proton.Client.IStreamSender.

The documentation for this class was generated from the following file:

src/Proton.Client/Client/Implementation/ClientStreamSender.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ BeginMessage()

◆ BeginMessageAsync()

◆ Send< T >()

◆ SendAsync< T >()

◆ TrySend< T >()

◆ TrySendAsync< T >()