Interface IErlTransport

General interface of TCP transports (i.e. usual TCP channel or SSH tunneled TCP channel)

Inherited Members
System.IDisposable.Dispose()
Namespace: NFX.Erlang
Assembly: NFX.Erlang.dll
Syntax
public interface IErlTransport : IDisposable

Properties

ConnectTimeout

ConnectTimeout in milliseconds

Declaration
int ConnectTimeout { get; set; }
Property Value
Type Description
System.Int32

NoDelay

NoDelay socket

Declaration
bool NoDelay { get; set; }
Property Value
Type Description
System.Boolean

NodeName

Erlang node name

Declaration
string NodeName { get; set; }
Property Value
Type Description
System.String

ReceiveBufferSize

Set receive buffer size

Declaration
int ReceiveBufferSize { get; set; }
Property Value
Type Description
System.Int32

RemoteEndPoint

Remote endpoint

Declaration
EndPoint RemoteEndPoint { get; }
Property Value
Type Description
System.Net.EndPoint

SendBufferSize

Set send buffer size

Declaration
int SendBufferSize { get; set; }
Property Value
Type Description
System.Int32

SSHAuthenticationType

Type of auth on SSH server. Valid values: "PublicKey", "Password".

Declaration
string SSHAuthenticationType { get; set; }
Property Value
Type Description
System.String

SSHPrivateKeyFilePath

Private key file path (only for AuthenticationType = PublicKey) Required SSH2 ENCRYPTED PRIVATE KEY format.

Declaration
string SSHPrivateKeyFilePath { get; set; }
Property Value
Type Description
System.String

SSHServerPort

Port of SSH server

Declaration
int SSHServerPort { get; set; }
Property Value
Type Description
System.Int32

SSHUserName

SSH user name

Declaration
string SSHUserName { get; set; }
Property Value
Type Description
System.String

Methods

Close()

Close connection

Declaration
void Close()

Connect(String, Int32)

Connects to remote host:port

Declaration
void Connect(string host, int port)
Parameters
Type Name Description
System.String host
System.Int32 port

Connect(String, Int32, Int32)

Connects to remote host:port with a timeout in milliseconds

Declaration
void Connect(string host, int port, int timeoutMsec)
Parameters
Type Name Description
System.String host
System.Int32 port
System.Int32 timeoutMsec

GetStream()

Network stream

Declaration
Stream GetStream()
Returns
Type Description
System.IO.Stream

SetSocketOption(SocketOptionLevel, SocketOptionName, Boolean)

Sets cocket options

Declaration
void SetSocketOption(SocketOptionLevel optionLevel, SocketOptionName optionName, bool optionValue)
Parameters
Type Name Description
System.Net.Sockets.SocketOptionLevel optionLevel
System.Net.Sockets.SocketOptionName optionName
System.Boolean optionValue

Events

Trace

Trace event

Declaration
event TraceEventHandler Trace
Event Type
Type Description
TraceEventHandler

Extension Methods