Class TcpClientTransport

Namespace

IceRpc.Transports.Tcp

Assembly

IceRpc.dll

Implements IDuplexClientTransport for the tcp transport.

public class TcpClientTransport : IDuplexClientTransport

Inheritance

object

TcpClientTransport

Implements

IDuplexClientTransport

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TcpClientTransport()

Constructs a TcpClientTransport.

public TcpClientTransport()

TcpClientTransport(TcpClientTransportOptions)

Constructs a TcpClientTransport.

public TcpClientTransport(TcpClientTransportOptions options)

Parameters

options TcpClientTransportOptions

The transport options.

Properties

DefaultName

Gets the default transport name.

public string DefaultName { get; }

Property Value

string

The transport accepts transport addresses that use this name as the TransportName. Some transports may accept additional names beyond this default.

Methods

CreateConnection(TransportAddress, DuplexConnectionOptions, SslClientAuthenticationOptions?)

Creates a new transport connection to the specified transport address.

public IDuplexConnection CreateConnection(TransportAddress transportAddress, DuplexConnectionOptions options, SslClientAuthenticationOptions? clientAuthenticationOptions)

Parameters

transportAddress TransportAddress

The transport address to connect to.

options DuplexConnectionOptions

The duplex connection options.

clientAuthenticationOptions SslClientAuthenticationOptions

The SSL client authentication options.

Returns

IDuplexConnection

The new transport connection. This connection is not yet connected.

Remarks

The IceRPC core can call this method concurrently so it must be thread-safe.

IsSslRequired(string?)

Determines whether this transport requires SSL for the specified transport name.

public bool IsSslRequired(string? transportName)

Parameters

transportName string

The transport name, or null which is equivalent to DefaultName.

Returns

bool

true if SSL is required; otherwise, false.

Exceptions

NotSupportedException

Thrown if transportName is not supported by this transport.