Class ConnectionParameters

Namespace

VAST.Transport

Assembly

VAST.Common.dll

Represents extended connection parameters for establishing network connections.

public class ConnectionParameters

Inheritance

object

ConnectionParameters

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ConnectionParameters()

Initializes a new instance of the ConnectionParameters class.

public ConnectionParameters()

Properties

CertificateServerName

Gets or sets the server name that should match the TLS certificate.

public string CertificateServerName { get; set; }

Property Value

string

CertificateThumbprint

Gets or sets the thumbprint of the certificate to use for server TLS connections.

public string CertificateThumbprint { get; set; }

Property Value

string

ConnectEventHandler

Gets or sets the event handler for connection established events.

public EventHandler<TransportArgs> ConnectEventHandler { get; set; }

Property Value

EventHandler<TransportArgs>

DisableMulticastLoop

Gets or sets a value indicating whether to disable multicast loopback.

public bool DisableMulticastLoop { get; set; }

Property Value

bool

DisconnectEventHandler

Gets or sets the event handler for disconnection events.

public EventHandler<TransportArgs> DisconnectEventHandler { get; set; }

Property Value

EventHandler<TransportArgs>

ExtraData

Gets or sets extra data that may be required by certain transport implementations.

public object ExtraData { get; set; }

Property Value

object

IsListener

Gets or sets a value indicating whether this connection is a listener.

public bool IsListener { get; set; }

Property Value

bool

LocalBindingEndPoint

Gets or sets the local binding endpoint.

public IPEndPoint LocalBindingEndPoint { get; set; }

Property Value

IPEndPoint

Remarks

Must be specified when there are multiple local network interfaces and a multicast remote endpoint.

MaxConsecutiveUdpReceiveErrors

Gets or sets the maximum consecutive receive errors a UDP socket can tolerate before raising an error.

public int? MaxConsecutiveUdpReceiveErrors { get; set; }

Property Value

int?

MaxSendQueueSize

Gets or sets the maximum send queue size.

public int MaxSendQueueSize { get; set; }

Property Value

int

Remarks

A value of -1 indicates no limit.

Protocol

Gets or sets the connection protocol.

public ProtocolType Protocol { get; set; }

Property Value

ProtocolType

ReceiveEventHandler

Gets or sets the event handler for data receive events.

public EventHandler<TransportArgs> ReceiveEventHandler { get; set; }

Property Value

EventHandler<TransportArgs>

RecvSocketBufferSize

Gets or sets the receive socket buffer size in bytes.

public int RecvSocketBufferSize { get; set; }

Property Value

int

RemoteEndPoint

Gets or sets the remote endpoint to connect to.

public IPEndPoint RemoteEndPoint { get; set; }

Property Value

IPEndPoint

ReuseLocalAddr

Gets or sets a value indicating whether to reuse the local endpoint address.

public bool ReuseLocalAddr { get; set; }

Property Value

bool

SendOnly

Gets or sets a value indicating whether this is a send-only connection that should not start a receive loop.

public bool? SendOnly { get; set; }

Property Value

bool?

SendSocketBufferSize

Gets or sets the send socket buffer size in bytes.

public int SendSocketBufferSize { get; set; }

Property Value

int

Ttl

Gets or sets the TTL (Time To Live) parameter for multicast connections.

public int? Ttl { get; set; }

Property Value

int?

Remarks

If not specified, the default value of 1 will be used. This property is ignored for unicast connections.

UseTls

Gets or sets a value indicating whether to use TLS for the connection.

public bool UseTls { get; set; }

Property Value

bool

UserContext

Gets or sets a user-defined context object associated with the connection.

public object UserContext { get; set; }

Property Value

object