Interface ISessionAttributes

Namespace

PushTechnology.ClientInterface.Client.Session

Assembly

Diffusion.Client.dll

The attributes of a ISession.

public interface ISessionAttributes

Examples

An instance of this interface can be obtained by calling Attributes.

// session is a previously obtained ISession instance.
var attributes = session.Attributes;

Remarks

These attributes will be set by ISessionFactory.

---

Note

This interface does not require user implementation and is only used to hide implementation details.

Added in 5.0.

Properties

ConnectionTimeout

Gets the connection timeout value in milliseconds.

int ConnectionTimeout { get; }

Property Value

int

The connection timeout value in milliseconds.

Remarks

Added in 5.0.

See Also

ConnectionTimeout(int)

HttpProxyAuth

Gets the proxy authenticator used to route a connection to the server via an HTTP proxy.

IHttpProxyAuthentication HttpProxyAuth { get; }

Property Value

IHttpProxyAuthentication

The proxy authenticator.

Remarks

Added in 5.1.

See Also

HttpProxy(string, int)

HttpProxy(string, int, IHttpProxyAuthentication)

HttpProxyHost

Gets the proxy host name used to route a connection to the server via an HTTP proxy.

string HttpProxyHost { get; }

Property Value

string

The proxy host.

Remarks

Added in 5.1.

See Also

HttpProxy(string, int)

HttpProxy(string, int, IHttpProxyAuthentication)

HttpProxyPort

Gets the proxy port used to route a connection to the server via an HTTP proxy.

int HttpProxyPort { get; }

Property Value

int

The proxy port.

Remarks

Added in 5.1.

See Also

HttpProxy(string, int)

HttpProxy(string, int, IHttpProxyAuthentication)

InitialRetryStrategy

Returns the initial retry strategy.

RetryStrategy InitialRetryStrategy { get; }

Property Value

RetryStrategy

The initial retry strategy used by the session.

Remarks

Added in 6.9.

See Also

InitialRetryStrategy(RetryStrategy)

InputBufferSize

Gets the input buffer size.

int InputBufferSize { get; }

Property Value

int

The input buffer size in bytes.

Remarks

Added in 5.0.

See Also

InputBufferSize(int)

LocalEndPoint

Gets the local endpoint the session used for the connection.

IPEndPoint LocalEndPoint { get; }

Property Value

IPEndPoint

The local endpoint this session used for the connection.

Remarks

This property will return the same endpoint that has been passed to the ISessionFactory.

---

Added in 6.4.

See Also

LocalEndPoint(IPEndPoint)

MaximumMessageSize

Gets the maximum message size that will be accepted by this session.

int MaximumMessageSize { get; }

Property Value

int

The maximum message size in bytes.

Remarks

Added in 5.0.

See Also

MaximumMessageSize(int)

MaximumQueueSize

Gets the maximum size of the outbound message queue.

int MaximumQueueSize { get; }

Property Value

int

The maximum number of messages that can be queued on the outbound message queue.

Remarks

Added in 5.9.

See Also

MaximumQueueSize(int)

OutputBufferSize

Gets the output buffer size.

int OutputBufferSize { get; }

Property Value

int

The output buffer size in bytes.

Remarks

Added in 5.0.

See Also

OutputBufferSize(int)

ReconnectionStrategy

Gets the reconnection strategy.

IReconnectionStrategy ReconnectionStrategy { get; }

Property Value

IReconnectionStrategy

The reconnection strategy.

Remarks

Added in 5.5.

See Also

ReconnectionStrategy(IReconnectionStrategy)

ReconnectionTimeout

Gets the reconnection timeout in milliseconds.

int ReconnectionTimeout { get; }

Property Value

int

The reconnection timeout in milliseconds.

Remarks

Added in 5.5.

See Also

ReconnectionTimeout(int)

RecoveryBufferSize

Gets the maximum number of sent messages that can be recovered on reconnection.

int RecoveryBufferSize { get; }

Property Value

int

The recovery buffer size in messages.

Remarks

Added in 6.0.

See Also

RecoveryBufferSize(int)

ServerUrl

Gets the URL used to create the session.

string ServerUrl { get; }

Property Value

string

The URL used to create the session.

Remarks

Added in 5.0.

See Also

Open(string)

WriteTimeout

Gets the write timeout value in milliseconds.

int WriteTimeout { get; }

Property Value

int

The write timeout value in milliseconds.

Remarks

Added in 5.0.

See Also

WriteTimeout(int)