Interface ISessionAttributes

The attributes of a ISession.

Namespace: PushTechnology.ClientInterface.Client.Session

Assembly: Diffusion.Client.dll

Syntax

public interface ISessionAttributes

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.

Examples

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

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

Properties

ConnectionTimeout

Gets the connection timeout value in milliseconds.

Declaration

int ConnectionTimeout { get; }

Property Value

Type	Description
System.Int32	The connection timeout value in milliseconds.

Remarks

Added in 5.0.

See Also

ConnectionTimeout(Int32)

HttpProxyAuth

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

Declaration

IHttpProxyAuthentication HttpProxyAuth { get; }

Property Value

Type	Description
IHttpProxyAuthentication	The proxy authenticator.

Remarks

Added in 5.1.

See Also

HttpProxy(String, Int32)

HttpProxy(String, Int32, IHttpProxyAuthentication)

HttpProxyHost

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

Declaration

string HttpProxyHost { get; }

Property Value

Type	Description
System.String	The proxy host.

Remarks

Added in 5.1.

See Also

HttpProxy(String, Int32)

HttpProxy(String, Int32, IHttpProxyAuthentication)

HttpProxyPort

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

Declaration

int HttpProxyPort { get; }

Property Value

Type	Description
System.Int32	The proxy port.

Remarks

Added in 5.1.

See Also

HttpProxy(String, Int32)

HttpProxy(String, Int32, IHttpProxyAuthentication)

InitialRetryStrategy

Returns the initial retry strategy.

Declaration

RetryStrategy InitialRetryStrategy { get; }

Property Value

Type	Description
RetryStrategy	The initial retry strategy used by the session.

Remarks

Added in 6.9.

See Also

InitialRetryStrategy(RetryStrategy)

InputBufferSize

Gets the input buffer size.

Declaration

int InputBufferSize { get; }

Property Value

Type	Description
System.Int32	The input buffer size in bytes.

Remarks

Added in 5.0.

See Also

InputBufferSize(Int32)

LocalEndPoint

Gets the local endpoint the session used for the connection.

Declaration

IPEndPoint LocalEndPoint { get; }

Property Value

Type	Description
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.

Declaration

int MaximumMessageSize { get; }

Property Value

Type	Description
System.Int32	The maximum message size in bytes.

Remarks

Added in 5.0.

See Also

MaximumMessageSize(Int32)

MaximumQueueSize

Gets the maximum size of the outbound message queue.

Declaration

int MaximumQueueSize { get; }

Property Value

Type	Description
System.Int32	The maximum number of messages that can be queued on the outbound message queue.

Remarks

Added in 5.9.

See Also

MaximumQueueSize(Int32)

OutputBufferSize

Gets the output buffer size.

Declaration

int OutputBufferSize { get; }

Property Value

Type	Description
System.Int32	The output buffer size in bytes.

Remarks

Added in 5.0.

See Also

OutputBufferSize(Int32)

ReconnectionStrategy

Gets the reconnection strategy.

Declaration

IReconnectionStrategy ReconnectionStrategy { get; }

Property Value

Type	Description
IReconnectionStrategy	The reconnection strategy.

Remarks

Added in 5.5.

See Also

ReconnectionStrategy(IReconnectionStrategy)

ReconnectionTimeout

Gets the reconnection timeout in milliseconds.

Declaration

int ReconnectionTimeout { get; }

Property Value

Type	Description
System.Int32	The reconnection timeout in milliseconds.

Remarks

Added in 5.5.

See Also

ReconnectionTimeout(Int32)

RecoveryBufferSize

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

Declaration

int RecoveryBufferSize { get; }

Property Value

Type	Description
System.Int32	The recovery buffer size in messages.

Remarks

Added in 6.0.

See Also

RecoveryBufferSize(Int32)

ServerUrl

Gets the URL used to create the session.

Declaration

string ServerUrl { get; }

Property Value

Type	Description
System.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.

Declaration

int WriteTimeout { get; }

Property Value

Type	Description
System.Int32	The write timeout value in milliseconds.

Remarks

Added in 5.0.

See Also

WriteTimeout(Int32)