Proton DotNet
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Properties | List of all members
Apache.Qpid.Proton.Client.TransportOptions Class Reference

Options that control the I/O level transport configuration. More...

Public Member Functions

 TransportOptions ()
 Creates a default transport options instance.
 
 TransportOptions (TransportOptions other)
 Create a transport options instance that copies the configuration from the given instance.
 
object Clone ()
 Clone this options instance, changes to the cloned options are not reflected in this options instance.
 

Static Public Attributes

static readonly int DEFAULT_SEND_BUFFER_SIZE = 64 * 1024
 
static readonly int DEFAULT_RECEIVE_BUFFER_SIZE = DEFAULT_SEND_BUFFER_SIZE
 
static readonly bool DEFAULT_TCP_NO_DELAY = true
 
static readonly bool DEFAULT_TCP_KEEP_ALIVE = false
 
static readonly uint DEFAULT_SO_LINGER = uint.MinValue
 
static readonly uint DEFAULT_SO_TIMEOUT = 0
 
static readonly int DEFAULT_TCP_PORT = 5672
 
static readonly int DEFAULT_LOCAL_PORT = 0
 
static readonly int DEFAULT_WEBSOCKET_MAX_FRAME_SIZE = 65535
 
static readonly bool DEFAULT_TRACE_BYTES = false
 

Properties

int DefaultTcpPort = DEFAULT_TCP_PORT [get, set]
 Configures the default TCP port that all client connections should use if none is provided in the connect call.
 
string LocalAddress [get, set]
 Assigned local address that the client should bind to when creating a connection to the remote. The user is responsible for ensuring this local address is free and can be bound to otherwise an error will be thrown on connect.
 
int LocalPort = DEFAULT_LOCAL_PORT [get, set]
 Assigned local port that the connection should bind to when attempting to connect to the remote. The user is responsible for ensuring this local port is free otherwise an error will be thrown on connect.
 
bool TraceBytes = DEFAULT_TRACE_BYTES [get, set]
 Configures whether the IO layer should write the incoming and outgoing bytes to the logging framework. By default this option is configured to not trace the bytes as this is a high impact operation and will result in a large amount of additional logging noise.
 
bool TcpNoDelay = DEFAULT_TCP_NO_DELAY [get, set]
 Configures whether the TCP_NO_DELAY options is set on the created TCP connection (defaults to true).
 
int SendBufferSize = DEFAULT_SEND_BUFFER_SIZE [get, set]
 Configures the send buffer size for the underlying transport.
 
int ReceiveBufferSize = DEFAULT_RECEIVE_BUFFER_SIZE [get, set]
 Configures the receive buffer size for the underlying transport.
 
uint SoLinger = DEFAULT_SO_LINGER [get, set]
 Configures the linger value applied to the underlying transport which by default is disabled.
 
uint SendTimeout = DEFAULT_SO_TIMEOUT [get, set]
 Configures the transport level send timeout value which by default is set to infinite wait.
 
uint ReceiveTimeout = DEFAULT_SO_TIMEOUT [get, set]
 Configures the transport level receive timeout value which by default is set to infinite wait.
 

Detailed Description

Options that control the I/O level transport configuration.

Constructor & Destructor Documentation

◆ TransportOptions()

Apache.Qpid.Proton.Client.TransportOptions.TransportOptions ( TransportOptions  other)
inline

Create a transport options instance that copies the configuration from the given instance.

Parameters
otherThe target options instance to copy

Member Function Documentation

◆ Clone()

object Apache.Qpid.Proton.Client.TransportOptions.Clone ( )
inline

Clone this options instance, changes to the cloned options are not reflected in this options instance.

Returns
A deep copy of this options instance.

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