CommandBasedClient

Overview

An abstract base class. You will usually deal with the separate descendants SmtpClient, Pop3Client and FtpClient that descend from this class.

Location


 

constructor  protected

 

constructor

 

CommandBasedClient()

 

init()

 

Sub New()

Binding  virtual    (declared in Client)

Obsolete - Please use BindingV4 and BindingV6 instead.

 

property Binding: Binding read;

 

Binding Binding { get; }

 

var Binding: Binding { get{} }

 

ReadOnly Property Binding() As Binding

BindingV4  virtual    (declared in Client)

Gets the binding which provides properties and methods such as address family, IPv4 address, port number etc for client to connect to the host network.

 

property BindingV4: Binding read;

 

Binding BindingV4 { get; }

 

var BindingV4: Binding { get{} }

 

ReadOnly Property BindingV4() As Binding

BindingV6  virtual    (declared in Client)

Gets the binding which provides properties and methods such as address family, IPv6 address, port number etc for client to connect to the host network.

 

property BindingV6: Binding read;

 

Binding BindingV6 { get; }

 

var BindingV6: Binding { get{} }

 

ReadOnly Property BindingV6() As Binding

Close  virtual

Closes current connection.

 

method Close

 

void Close()

 

func Close()

 

Sub Close()

Connect  virtual    (declared in Client)

 

method Connect: Connection

 

Connection Connect()

 

func Connect() -> Connection

 

Function Connect() As Connection

Connect (IPAddress, Int32): Connection  virtual    (declared in Client)

 

method Connect(host: IPAddress; port: Int32): Connection

 

Connection Connect(IPAddress host, Int32 port)

 

func Connect(_ host: IPAddress, _ port: Int32) -> Connection

 

Function Connect(host As IPAddress, port As Int32) As Connection

Parameters:

  • host:
  • port:

Connect (String, Int32): Connection  virtual    (declared in Client)

 

method Connect(hostname: String; port: Int32): Connection

 

Connection Connect(String hostname, Int32 port)

 

func Connect(_ hostname: String, _ port: Int32) -> Connection

 

Function Connect(hostname As String, port As Int32) As Connection

Parameters:

  • hostname:
  • port:

Connect (IPAddress, Int32, Binding): Connection  virtual    (declared in Client)

Overloaded. Use to connect the client to a remote network host using the specified host name (HostName) or IP address (HostAddress) and port number (Port) and/or Binding (BindingV4 or BindingV6).

 

class method Connect(host: IPAddress; port: Int32; binding: Binding): Connection

 

static Connection Connect(IPAddress host, Int32 port, Binding binding)

 

static func Connect(_ host: IPAddress, _ port: Int32, _ binding: Binding) -> Connection

 

Shared Function Connect(host As IPAddress, port As Int32, binding As Binding) As Connection

Parameters:

  • host:
  • port:
  • binding:

Connect (String, Int32, Binding): Connection  virtual    (declared in Client)

Overloaded. Use to connect the client to a remote network host using the specified host name (HostName) or IP address (HostAddress) and port number (Port) and/or Binding (BindingV4 or BindingV6).

 

class method Connect(hostname: String; port: Int32; binding: Binding): Connection

 

static Connection Connect(String hostname, Int32 port, Binding binding)

 

static func Connect(_ hostname: String, _ port: Int32, _ binding: Binding) -> Connection

 

Shared Function Connect(hostname As String, port As Int32, binding As Binding) As Connection

Parameters:

  • hostname:
  • port:
  • binding:

Connected  virtual

Returns the state of CurrentConnection. If it is false then CurrentConnection is not specified (null).

 

property Connected: Boolean read;

 

Boolean Connected { get; }

 

var Connected: Boolean { get{} }

 

ReadOnly Property Connected() As Boolean

ConnectionClass    (declared in Client) .NET, .NET Core 5.0, .NET Standard 2.0

Use the ConnectionClass property to specify an alternative Connection class to be used for out coming data connections. The class described by the assigned Type must be a descendant of Connection, and will be used for all connections that are established after the property has been set. Existing connections are not affected by changing the property.

If ConnectionType is null (default), instances of the Connection base class will be used.

 

property ConnectionClass: Type read write;

 

Type ConnectionClass { get; set; }

 

var ConnectionClass: Type { get{} set{} }

 

Property ConnectionClass() As Type

ConnectionFactory  virtual    (declared in Client)

Represents an interface for a connection.

 

property ConnectionFactory: IConnectionFactory read write;

 

IConnectionFactory ConnectionFactory { get; set; }

 

var ConnectionFactory: IConnectionFactory { get{} set{} }

 

Property ConnectionFactory() As IConnectionFactory

ConnectionPool  protected virtual    (declared in Client)

 

property ConnectionPool: ConnectionPool read write;

 

ConnectionPool ConnectionPool { get; set; }

 

var ConnectionPool: ConnectionPool { get{} set{} }

 

Property ConnectionPool() As ConnectionPool

ConnectNew  virtual    (declared in Client)

 

method ConnectNew: Connection

 

Connection ConnectNew()

 

func ConnectNew() -> Connection

 

Function ConnectNew() As Connection

ConnectNew (IPAddress, Int32): Connection  virtual    (declared in Client)

Overloaded. Opens and returns new connection with specified IP address and port.

 

method ConnectNew(host: IPAddress; port: Int32): Connection

 

Connection ConnectNew(IPAddress host, Int32 port)

 

func ConnectNew(_ host: IPAddress, _ port: Int32) -> Connection

 

Function ConnectNew(host As IPAddress, port As Int32) As Connection

Parameters:

  • host:
  • port:

ConnectNew (String, Int32): Connection  virtual    (declared in Client)

 

method ConnectNew(hostname: String; port: Int32): Connection

 

Connection ConnectNew(String hostname, Int32 port)

 

func ConnectNew(_ hostname: String, _ port: Int32) -> Connection

 

Function ConnectNew(hostname As String, port As Int32) As Connection

Parameters:

  • hostname:
  • port:

CurrentConnection  virtual

Returns current connection.

 

property CurrentConnection: Connection read;

 

Connection CurrentConnection { get; }

 

var CurrentConnection: Connection { get{} }

 

ReadOnly Property CurrentConnection() As Connection

Dispose  protected virtual    (declared in Component) Island, Toffee

 

method Dispose(disposing: Boolean)

 

void Dispose(Boolean disposing)

 

func Dispose(_ disposing: Boolean)

 

Sub Dispose(disposing As Boolean)

Parameters:

  • disposing:

DnsResolveType  virtual    (declared in Client)

Determines if the specified HostName should be look up only Once per application run (if you establish multiple connections to the server, the subsequent connections will use the cached IPAddress) or Always, for each connect (the Hostname will be resolved again for each subsequet connect).

You'll usually only change this setting off the defaut (Once) if you anticipate the IPAddress of the target host to change frequently.

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(DnsResolveType.Once)]
property DnsResolveType: DnsResolveType read write;
// Island
property DnsResolveType: DnsResolveType read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(DnsResolveType.Once)]
DnsResolveType DnsResolveType { get; set; }
// Island
DnsResolveType DnsResolveType { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(DnsResolveType.Once)
var DnsResolveType: DnsResolveType { get{} set{} }
// Island, Toffee
var DnsResolveType: DnsResolveType { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(DnsResolveType.Once)>
Property DnsResolveType() As DnsResolveType
// Island
Property DnsResolveType() As DnsResolveType

EnableNagle  virtual    (declared in Client)

Set its value to true to enable the Nagle algorithm for send coalescing.

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(false)]
property EnableNagle: Boolean read write;
// Island
property EnableNagle: Boolean read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(false)]
Boolean EnableNagle { get; set; }
// Island
Boolean EnableNagle { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(false)
var EnableNagle: Boolean { get{} set{} }
// Island, Toffee
var EnableNagle: Boolean { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(false)>
Property EnableNagle() As Boolean
// Island
Property EnableNagle() As Boolean

GetConnection  protected virtual    (declared in Client)

 

method GetConnection(host: IPAddress; port: Int32): Connection

 

Connection GetConnection(IPAddress host, Int32 port)

 

func GetConnection(_ host: IPAddress, _ port: Int32) -> Connection

 

Function GetConnection(host As IPAddress, port As Int32) As Connection

Parameters:

  • host:
  • port:

HostAddress  virtual    (declared in Client)

Gets or sets an Internet Protocol (IP) address.

 

property HostAddress: IPAddress read write;

 

IPAddress HostAddress { get; set; }

 

var HostAddress: IPAddress { get{} set{} }

 

Property HostAddress() As IPAddress

HostName  virtual    (declared in Client)

The server host name or IP address that you intend the client to connect to.

 

property HostName: String read write;

 

String HostName { get; set; }

 

var HostName: String { get{} set{} }

 

Property HostName() As String

LastResponseNo  virtual

 

property LastResponseNo: Int32 read;

 

Int32 LastResponseNo { get; }

 

var LastResponseNo: Int32 { get{} }

 

ReadOnly Property LastResponseNo() As Int32

LastResponseText  virtual

 

property LastResponseText: String read;

 

String LastResponseText { get; }

 

var LastResponseText: String { get{} }

 

ReadOnly Property LastResponseText() As String

NewConnection  protected virtual    (declared in Client)

 

method NewConnection(binding: Binding): Connection

 

Connection NewConnection(Binding binding)

 

func NewConnection(_ binding: Binding) -> Connection

 

Function NewConnection(binding As Binding) As Connection

Parameters:

  • binding:

OnLog

 

event OnLog: ClientLogEvent
delegate:  method OnLog(sender: Object; e: ClientLogArgs)

 

delegate ClientLogEvent OnLog()
delegate:  void OnLog(Object sender, ClientLogArgs e)

 

__event ClientLogEvent: OnLog!
delegate:  func OnLog(_ sender: Object, _ e: ClientLogArgs)

 

Event OnLog As ClientLogEvent
delegate:  Sub OnLog(sender As Object, e As ClientLogArgs)

OnResolvedHostName    (declared in Client)

This event is fired after the hostname has been successfully resolved.

 

event OnResolvedHostName: OnResolvedHostNameEventHandler
delegate:  method OnResolvedHostName(sender: Object; e: OnResolvedHostNameEventArgs)

 

delegate OnResolvedHostNameEventHandler OnResolvedHostName()
delegate:  void OnResolvedHostName(Object sender, OnResolvedHostNameEventArgs e)

 

__event OnResolvedHostNameEventHandler: OnResolvedHostName!
delegate:  func OnResolvedHostName(_ sender: Object, _ e: OnResolvedHostNameEventArgs)

 

Event OnResolvedHostName As OnResolvedHostNameEventHandler
delegate:  Sub OnResolvedHostName(sender As Object, e As OnResolvedHostNameEventArgs)

OnResolveHostName    (declared in Client)

This event is fired before the Client attepts to resolve the sepcifed HostName to an IP address. It provides you with an option to perform the resolution yourself, obtain the IP address from an internal cache you're maintaing, or do some other processing (such as for example chaging the hostname to look up).

 

event OnResolveHostName: OnResolveHostNameEventHandler
delegate:  method OnResolveHostName(sender: Object; e: OnResolveHostNameEventArgs)

 

delegate OnResolveHostNameEventHandler OnResolveHostName()
delegate:  void OnResolveHostName(Object sender, OnResolveHostNameEventArgs e)

 

__event OnResolveHostNameEventHandler: OnResolveHostName!
delegate:  func OnResolveHostName(_ sender: Object, _ e: OnResolveHostNameEventArgs)

 

Event OnResolveHostName As OnResolveHostNameEventHandler
delegate:  Sub OnResolveHostName(sender As Object, e As OnResolveHostNameEventArgs)

Open  virtual

Opens current connection to the target system.

 

method Open

 

void Open()

 

func Open()

 

Sub Open()

Port  virtual    (declared in Client)

The server Port that you intend the client to connect to.

 

property Port: Int32 read write;

 

Int32 Port { get; set; }

 

var Port: Int32 { get{} set{} }

 

Property Port() As Int32

ReleaseConnection  protected virtual    (declared in Client)

 

method ReleaseConnection(connection: Connection)

 

void ReleaseConnection(Connection connection)

 

func ReleaseConnection(_ connection: Connection)

 

Sub ReleaseConnection(connection As Connection)

Parameters:

  • connection:

ResolveHostName  protected virtual    (declared in Client)

 

method ResolveHostName

 

void ResolveHostName()

 

func ResolveHostName()

 

Sub ResolveHostName()

ResolveHostNameIfNeeded  protected virtual    (declared in Client)

 

method ResolveHostNameIfNeeded

 

void ResolveHostNameIfNeeded()

 

func ResolveHostNameIfNeeded()

 

Sub ResolveHostNameIfNeeded()

SendAndWaitForResponse  protected virtual

 

method SendAndWaitForResponse(command: String; params validResponses: array of Int32): Boolean

 

Boolean SendAndWaitForResponse(String command, params Int32[] validResponses)

 

func SendAndWaitForResponse(_ command: String, _ validResponses: Int32...) -> Boolean

 

Function SendAndWaitForResponse(command As String, ParamArray validResponses As Int32()) As Boolean

Parameters:

  • command:
  • validResponses:

SendLog (TransferDirection, String, array of Object)  protected virtual

 

method SendLog(direction: TransferDirection; format: String; params parameters: array of Object)

 

void SendLog(TransferDirection direction, String format, params Object[] parameters)

 

func SendLog(_ direction: TransferDirection, _ format: String, _ parameters: Object...)

 

Sub SendLog(direction As TransferDirection, format As String, ParamArray parameters As Object())

Parameters:

  • direction:
  • format:
  • parameters:

SendLog (TransferDirection, String)  protected virtual

 

method SendLog(direction: TransferDirection; message: String)

 

void SendLog(TransferDirection direction, String message)

 

func SendLog(_ direction: TransferDirection, _ message: String)

 

Sub SendLog(direction As TransferDirection, message As String)

Parameters:

  • direction:
  • message:

TriggerOnResolvedHostName  protected virtual    (declared in Client)

 

method TriggerOnResolvedHostName(e: OnResolvedHostNameEventArgs)

 

void TriggerOnResolvedHostName(OnResolvedHostNameEventArgs e)

 

func TriggerOnResolvedHostName(_ e: OnResolvedHostNameEventArgs)

 

Sub TriggerOnResolvedHostName(e As OnResolvedHostNameEventArgs)

Parameters:

  • e:

TriggerOnResolveHostName  protected virtual    (declared in Client)

 

method TriggerOnResolveHostName(e: OnResolveHostNameEventArgs)

 

void TriggerOnResolveHostName(OnResolveHostNameEventArgs e)

 

func TriggerOnResolveHostName(_ e: OnResolveHostNameEventArgs)

 

Sub TriggerOnResolveHostName(e As OnResolveHostNameEventArgs)

Parameters:

  • e:

WaitForResponse  protected virtual

 

method WaitForResponse(params validResponses: array of Int32): Boolean

 

Boolean WaitForResponse(params Int32[] validResponses)

 

func WaitForResponse(_ validResponses: Int32...) -> Boolean

 

Function WaitForResponse(ParamArray validResponses As Int32()) As Boolean

Parameters:

  • validResponses:

 

Binding  virtual    (declared in Client)

Obsolete - Please use BindingV4 and BindingV6 instead.

 

property Binding: Binding read;

 

Binding Binding { get; }

 

var Binding: Binding { get{} }

 

ReadOnly Property Binding() As Binding

BindingV4  virtual    (declared in Client)

Gets the binding which provides properties and methods such as address family, IPv4 address, port number etc for client to connect to the host network.

 

property BindingV4: Binding read;

 

Binding BindingV4 { get; }

 

var BindingV4: Binding { get{} }

 

ReadOnly Property BindingV4() As Binding

BindingV6  virtual    (declared in Client)

Gets the binding which provides properties and methods such as address family, IPv6 address, port number etc for client to connect to the host network.

 

property BindingV6: Binding read;

 

Binding BindingV6 { get; }

 

var BindingV6: Binding { get{} }

 

ReadOnly Property BindingV6() As Binding

Connected  virtual

Returns the state of CurrentConnection. If it is false then CurrentConnection is not specified (null).

 

property Connected: Boolean read;

 

Boolean Connected { get; }

 

var Connected: Boolean { get{} }

 

ReadOnly Property Connected() As Boolean

ConnectionClass    (declared in Client) .NET, .NET Core 5.0, .NET Standard 2.0

Use the ConnectionClass property to specify an alternative Connection class to be used for out coming data connections. The class described by the assigned Type must be a descendant of Connection, and will be used for all connections that are established after the property has been set. Existing connections are not affected by changing the property.

If ConnectionType is null (default), instances of the Connection base class will be used.

 

property ConnectionClass: Type read write;

 

Type ConnectionClass { get; set; }

 

var ConnectionClass: Type { get{} set{} }

 

Property ConnectionClass() As Type

ConnectionFactory  virtual    (declared in Client)

Represents an interface for a connection.

 

property ConnectionFactory: IConnectionFactory read write;

 

IConnectionFactory ConnectionFactory { get; set; }

 

var ConnectionFactory: IConnectionFactory { get{} set{} }

 

Property ConnectionFactory() As IConnectionFactory

ConnectionPool  protected virtual    (declared in Client)

 

property ConnectionPool: ConnectionPool read write;

 

ConnectionPool ConnectionPool { get; set; }

 

var ConnectionPool: ConnectionPool { get{} set{} }

 

Property ConnectionPool() As ConnectionPool

CurrentConnection  virtual

Returns current connection.

 

property CurrentConnection: Connection read;

 

Connection CurrentConnection { get; }

 

var CurrentConnection: Connection { get{} }

 

ReadOnly Property CurrentConnection() As Connection

DnsResolveType  virtual    (declared in Client)

Determines if the specified HostName should be look up only Once per application run (if you establish multiple connections to the server, the subsequent connections will use the cached IPAddress) or Always, for each connect (the Hostname will be resolved again for each subsequet connect).

You'll usually only change this setting off the defaut (Once) if you anticipate the IPAddress of the target host to change frequently.

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(DnsResolveType.Once)]
property DnsResolveType: DnsResolveType read write;
// Island
property DnsResolveType: DnsResolveType read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(DnsResolveType.Once)]
DnsResolveType DnsResolveType { get; set; }
// Island
DnsResolveType DnsResolveType { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(DnsResolveType.Once)
var DnsResolveType: DnsResolveType { get{} set{} }
// Island, Toffee
var DnsResolveType: DnsResolveType { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(DnsResolveType.Once)>
Property DnsResolveType() As DnsResolveType
// Island
Property DnsResolveType() As DnsResolveType

EnableNagle  virtual    (declared in Client)

Set its value to true to enable the Nagle algorithm for send coalescing.

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(false)]
property EnableNagle: Boolean read write;
// Island
property EnableNagle: Boolean read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(false)]
Boolean EnableNagle { get; set; }
// Island
Boolean EnableNagle { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(false)
var EnableNagle: Boolean { get{} set{} }
// Island, Toffee
var EnableNagle: Boolean { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(false)>
Property EnableNagle() As Boolean
// Island
Property EnableNagle() As Boolean

HostAddress  virtual    (declared in Client)

Gets or sets an Internet Protocol (IP) address.

 

property HostAddress: IPAddress read write;

 

IPAddress HostAddress { get; set; }

 

var HostAddress: IPAddress { get{} set{} }

 

Property HostAddress() As IPAddress

HostName  virtual    (declared in Client)

The server host name or IP address that you intend the client to connect to.

 

property HostName: String read write;

 

String HostName { get; set; }

 

var HostName: String { get{} set{} }

 

Property HostName() As String

LastResponseNo  virtual

 

property LastResponseNo: Int32 read;

 

Int32 LastResponseNo { get; }

 

var LastResponseNo: Int32 { get{} }

 

ReadOnly Property LastResponseNo() As Int32

LastResponseText  virtual

 

property LastResponseText: String read;

 

String LastResponseText { get; }

 

var LastResponseText: String { get{} }

 

ReadOnly Property LastResponseText() As String

Port  virtual    (declared in Client)

The server Port that you intend the client to connect to.

 

property Port: Int32 read write;

 

Int32 Port { get; set; }

 

var Port: Int32 { get{} set{} }

 

Property Port() As Int32

 

Connect (IPAddress, Int32, Binding): Connection  virtual    (declared in Client)

Overloaded. Use to connect the client to a remote network host using the specified host name (HostName) or IP address (HostAddress) and port number (Port) and/or Binding (BindingV4 or BindingV6).

 

class method Connect(host: IPAddress; port: Int32; binding: Binding): Connection

 

static Connection Connect(IPAddress host, Int32 port, Binding binding)

 

static func Connect(_ host: IPAddress, _ port: Int32, _ binding: Binding) -> Connection

 

Shared Function Connect(host As IPAddress, port As Int32, binding As Binding) As Connection

Parameters:

  • host:
  • port:
  • binding:

Connect (String, Int32, Binding): Connection  virtual    (declared in Client)

Overloaded. Use to connect the client to a remote network host using the specified host name (HostName) or IP address (HostAddress) and port number (Port) and/or Binding (BindingV4 or BindingV6).

 

class method Connect(hostname: String; port: Int32; binding: Binding): Connection

 

static Connection Connect(String hostname, Int32 port, Binding binding)

 

static func Connect(_ hostname: String, _ port: Int32, _ binding: Binding) -> Connection

 

Shared Function Connect(hostname As String, port As Int32, binding As Binding) As Connection

Parameters:

  • hostname:
  • port:
  • binding:

 

constructor  protected

 

constructor

 

CommandBasedClient()

 

init()

 

Sub New()

Close  virtual

Closes current connection.

 

method Close

 

void Close()

 

func Close()

 

Sub Close()

Connect  virtual    (declared in Client)

 

method Connect: Connection

 

Connection Connect()

 

func Connect() -> Connection

 

Function Connect() As Connection

Connect (IPAddress, Int32): Connection  virtual    (declared in Client)

 

method Connect(host: IPAddress; port: Int32): Connection

 

Connection Connect(IPAddress host, Int32 port)

 

func Connect(_ host: IPAddress, _ port: Int32) -> Connection

 

Function Connect(host As IPAddress, port As Int32) As Connection

Parameters:

  • host:
  • port:

Connect (String, Int32): Connection  virtual    (declared in Client)

 

method Connect(hostname: String; port: Int32): Connection

 

Connection Connect(String hostname, Int32 port)

 

func Connect(_ hostname: String, _ port: Int32) -> Connection

 

Function Connect(hostname As String, port As Int32) As Connection

Parameters:

  • hostname:
  • port:

ConnectNew  virtual    (declared in Client)

 

method ConnectNew: Connection

 

Connection ConnectNew()

 

func ConnectNew() -> Connection

 

Function ConnectNew() As Connection

ConnectNew (IPAddress, Int32): Connection  virtual    (declared in Client)

Overloaded. Opens and returns new connection with specified IP address and port.

 

method ConnectNew(host: IPAddress; port: Int32): Connection

 

Connection ConnectNew(IPAddress host, Int32 port)

 

func ConnectNew(_ host: IPAddress, _ port: Int32) -> Connection

 

Function ConnectNew(host As IPAddress, port As Int32) As Connection

Parameters:

  • host:
  • port:

ConnectNew (String, Int32): Connection  virtual    (declared in Client)

 

method ConnectNew(hostname: String; port: Int32): Connection

 

Connection ConnectNew(String hostname, Int32 port)

 

func ConnectNew(_ hostname: String, _ port: Int32) -> Connection

 

Function ConnectNew(hostname As String, port As Int32) As Connection

Parameters:

  • hostname:
  • port:

Dispose  protected virtual    (declared in Component) Island, Toffee

 

method Dispose(disposing: Boolean)

 

void Dispose(Boolean disposing)

 

func Dispose(_ disposing: Boolean)

 

Sub Dispose(disposing As Boolean)

Parameters:

  • disposing:

GetConnection  protected virtual    (declared in Client)

 

method GetConnection(host: IPAddress; port: Int32): Connection

 

Connection GetConnection(IPAddress host, Int32 port)

 

func GetConnection(_ host: IPAddress, _ port: Int32) -> Connection

 

Function GetConnection(host As IPAddress, port As Int32) As Connection

Parameters:

  • host:
  • port:

NewConnection  protected virtual    (declared in Client)

 

method NewConnection(binding: Binding): Connection

 

Connection NewConnection(Binding binding)

 

func NewConnection(_ binding: Binding) -> Connection

 

Function NewConnection(binding As Binding) As Connection

Parameters:

  • binding:

Open  virtual

Opens current connection to the target system.

 

method Open

 

void Open()

 

func Open()

 

Sub Open()

ReleaseConnection  protected virtual    (declared in Client)

 

method ReleaseConnection(connection: Connection)

 

void ReleaseConnection(Connection connection)

 

func ReleaseConnection(_ connection: Connection)

 

Sub ReleaseConnection(connection As Connection)

Parameters:

  • connection:

ResolveHostName  protected virtual    (declared in Client)

 

method ResolveHostName

 

void ResolveHostName()

 

func ResolveHostName()

 

Sub ResolveHostName()

ResolveHostNameIfNeeded  protected virtual    (declared in Client)

 

method ResolveHostNameIfNeeded

 

void ResolveHostNameIfNeeded()

 

func ResolveHostNameIfNeeded()

 

Sub ResolveHostNameIfNeeded()

SendAndWaitForResponse  protected virtual

 

method SendAndWaitForResponse(command: String; params validResponses: array of Int32): Boolean

 

Boolean SendAndWaitForResponse(String command, params Int32[] validResponses)

 

func SendAndWaitForResponse(_ command: String, _ validResponses: Int32...) -> Boolean

 

Function SendAndWaitForResponse(command As String, ParamArray validResponses As Int32()) As Boolean

Parameters:

  • command:
  • validResponses:

SendLog (TransferDirection, String, array of Object)  protected virtual

 

method SendLog(direction: TransferDirection; format: String; params parameters: array of Object)

 

void SendLog(TransferDirection direction, String format, params Object[] parameters)

 

func SendLog(_ direction: TransferDirection, _ format: String, _ parameters: Object...)

 

Sub SendLog(direction As TransferDirection, format As String, ParamArray parameters As Object())

Parameters:

  • direction:
  • format:
  • parameters:

SendLog (TransferDirection, String)  protected virtual

 

method SendLog(direction: TransferDirection; message: String)

 

void SendLog(TransferDirection direction, String message)

 

func SendLog(_ direction: TransferDirection, _ message: String)

 

Sub SendLog(direction As TransferDirection, message As String)

Parameters:

  • direction:
  • message:

TriggerOnResolvedHostName  protected virtual    (declared in Client)

 

method TriggerOnResolvedHostName(e: OnResolvedHostNameEventArgs)

 

void TriggerOnResolvedHostName(OnResolvedHostNameEventArgs e)

 

func TriggerOnResolvedHostName(_ e: OnResolvedHostNameEventArgs)

 

Sub TriggerOnResolvedHostName(e As OnResolvedHostNameEventArgs)

Parameters:

  • e:

TriggerOnResolveHostName  protected virtual    (declared in Client)

 

method TriggerOnResolveHostName(e: OnResolveHostNameEventArgs)

 

void TriggerOnResolveHostName(OnResolveHostNameEventArgs e)

 

func TriggerOnResolveHostName(_ e: OnResolveHostNameEventArgs)

 

Sub TriggerOnResolveHostName(e As OnResolveHostNameEventArgs)

Parameters:

  • e:

WaitForResponse  protected virtual

 

method WaitForResponse(params validResponses: array of Int32): Boolean

 

Boolean WaitForResponse(params Int32[] validResponses)

 

func WaitForResponse(_ validResponses: Int32...) -> Boolean

 

Function WaitForResponse(ParamArray validResponses As Int32()) As Boolean

Parameters:

  • validResponses:

 

OnLog

 

event OnLog: ClientLogEvent
delegate:  method OnLog(sender: Object; e: ClientLogArgs)

 

delegate ClientLogEvent OnLog()
delegate:  void OnLog(Object sender, ClientLogArgs e)

 

__event ClientLogEvent: OnLog!
delegate:  func OnLog(_ sender: Object, _ e: ClientLogArgs)

 

Event OnLog As ClientLogEvent
delegate:  Sub OnLog(sender As Object, e As ClientLogArgs)

OnResolvedHostName    (declared in Client)

This event is fired after the hostname has been successfully resolved.

 

event OnResolvedHostName: OnResolvedHostNameEventHandler
delegate:  method OnResolvedHostName(sender: Object; e: OnResolvedHostNameEventArgs)

 

delegate OnResolvedHostNameEventHandler OnResolvedHostName()
delegate:  void OnResolvedHostName(Object sender, OnResolvedHostNameEventArgs e)

 

__event OnResolvedHostNameEventHandler: OnResolvedHostName!
delegate:  func OnResolvedHostName(_ sender: Object, _ e: OnResolvedHostNameEventArgs)

 

Event OnResolvedHostName As OnResolvedHostNameEventHandler
delegate:  Sub OnResolvedHostName(sender As Object, e As OnResolvedHostNameEventArgs)

OnResolveHostName    (declared in Client)

This event is fired before the Client attepts to resolve the sepcifed HostName to an IP address. It provides you with an option to perform the resolution yourself, obtain the IP address from an internal cache you're maintaing, or do some other processing (such as for example chaging the hostname to look up).

 

event OnResolveHostName: OnResolveHostNameEventHandler
delegate:  method OnResolveHostName(sender: Object; e: OnResolveHostNameEventArgs)

 

delegate OnResolveHostNameEventHandler OnResolveHostName()
delegate:  void OnResolveHostName(Object sender, OnResolveHostNameEventArgs e)

 

__event OnResolveHostNameEventHandler: OnResolveHostName!
delegate:  func OnResolveHostName(_ sender: Object, _ e: OnResolveHostNameEventArgs)

 

Event OnResolveHostName As OnResolveHostNameEventHandler
delegate:  Sub OnResolveHostName(sender As Object, e As OnResolveHostNameEventArgs)