Apache.Qpid.Proton.Client.ISender Interface Reference

A single AMQP sender instance. More...

Inheritance diagram for Apache.Qpid.Proton.Client.ISender:

Public Member Functions
ITracker	Send< T > (IMessage< T > message, IDictionary< string, object > deliveryAnnotations=null)
	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. More...
Task< ITracker >	SendAsync< T > (IMessage< T > message, IDictionary< string, object > deliveryAnnotations=null)
	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. More...
ITracker	TrySend< T > (IMessage< T > message, IDictionary< string, object > deliveryAnnotations=null)
	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. More...
Task< ITracker >	TrySendAsync< T > (IMessage< T > message, IDictionary< string, object > deliveryAnnotations=null)
	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. More...

Detailed Description

A single AMQP sender instance.

Member Function Documentation

Send< T >()

ITracker Apache.Qpid.Proton.Client.ISender.Send< T >	(	IMessage< T >	message,
		IDictionary< string, object >	deliveryAnnotations = null
	)

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

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientSender.

SendAsync< T >()

Task<ITracker> Apache.Qpid.Proton.Client.ISender.SendAsync< T >	(	IMessage< T >	message,
		IDictionary< string, object >	deliveryAnnotations = null
	)

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

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientSender.

TrySend< T >()

ITracker Apache.Qpid.Proton.Client.ISender.TrySend< T >	(	IMessage< T >	message,
		IDictionary< string, object >	deliveryAnnotations = null
	)

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

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientSender.

TrySendAsync< T >()

Task<ITracker> Apache.Qpid.Proton.Client.ISender.TrySendAsync< T >	(	IMessage< T >	message,
		IDictionary< string, object >	deliveryAnnotations = null
	)

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

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientSender.

---

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

• src/Proton.Client/Client/ISender.cs