Namespaces — Interfaces — Classes — Implements
Overview
Abstract client component, the base for all other clients.
Location
Properties
| Binding
|
|
Obsolete - Please use BindingV4 and BindingV6 instead.
Prism: property Binding: Binding read
C#: Binding Binding { get; }
VB: Property ReadOnly Binding As Binding
|
| BindingV4
|
|
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.
Prism: property BindingV4: Binding read
C#: Binding BindingV4 { get; }
VB: Property ReadOnly BindingV4 As Binding
|
| BindingV6
|
|
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.
Prism: property BindingV6: Binding read
C#: Binding BindingV6 { get; }
VB: Property ReadOnly BindingV6 As Binding
|
| ConnectionClass
|
|
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.
Prism: property ConnectionClass: Type read write
C#: Type ConnectionClass { get; set; }
VB: Property ConnectionClass As Type
|
| ConnectionFactory
|
|
Represents an interface for a connection.
Prism: property ConnectionFactory: IConnectionFactory read write
C#: IConnectionFactory ConnectionFactory { get; set; }
VB: Property ConnectionFactory As IConnectionFactory
|
| ConnectionPool protected
|
|
Prism: property ConnectionPool: ConnectionPool read write
C#: ConnectionPool ConnectionPool { get; set; }
VB: Property ConnectionPool As ConnectionPool
|
| DnsResolveType
|
|
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.
Prism: property DnsResolveType: DnsResolveType read write
C#: DnsResolveType DnsResolveType { get; set; }
VB: Property DnsResolveType As DnsResolveType
|
| EnableNagle
|
|
Set its value to true to enable the Nagle algorithm for send coalescing.
Prism: property EnableNagle: Boolean read write
C#: Boolean EnableNagle { get; set; }
VB: Property EnableNagle As Boolean
|
| HostAddress
|
|
Gets or sets an Internet Protocol (IP) address.
Prism: property HostAddress: IPAddress read write
C#: IPAddress HostAddress { get; set; }
VB: Property HostAddress As IPAddress
|
| HostName
|
|
The server host name or IP address that you intend the client to connect to.
Prism: property HostName: String read write
C#: String HostName { get; set; }
VB: Property HostName As String
|
| Port
|
|
The server Port that you intend the client to connect to.
Prism: property Port: Int32 read write
C#: Int32 Port { get; set; }
VB: Property Port As Int32
|
| SslOptions
|
|
Prism: property SslOptions: SslConnectionFactory read write
C#: SslConnectionFactory SslOptions { get; set; }
VB: Property SslOptions As SslConnectionFactory
|
Class Methods
| Connect (IPAddress, Int32, Binding): Connection
|
|
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).
Oxygene: class method Connect(host: IPAddress; port: Int32; binding: Binding): Connection
C#: static Connection Connect(IPAddress host, Int32 port, Binding binding)
VB: Shared Function Connect(host As IPAddress, port As Int32, binding As Binding) As Connection
Parameters:
|
| Connect (String, Int32, Binding): Connection
|
|
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).
Oxygene: class method Connect(hostname: String; port: Int32; binding: Binding): Connection
C#: static Connection Connect(String hostname, Int32 port, Binding binding)
VB: Shared Function Connect(hostname As String, port As Int32, binding As Binding) As Connection
Parameters:
|
Instance Methods
| constructor protected
|
|
Oxygene: constructor
C#: constructor()
VB: Sub New
|
| Connect (): Connection
|
|
Oxygene: method Connect: Connection
C#: Connection Connect()
VB: Function Connect As Connection
|
| Connect (IPAddress, Int32): Connection
|
|
Oxygene: method Connect(host: IPAddress; port: Int32): Connection
C#: Connection Connect(IPAddress host, Int32 port)
VB: Function Connect(host As IPAddress, port As Int32) As Connection
Parameters:
|
| Connect (String, Int32): Connection
|
|
Oxygene: method Connect(hostname: String; port: Int32): Connection
C#: Connection Connect(String hostname, Int32 port)
VB: Function Connect(hostname As String, port As Int32) As Connection
Parameters:
|
| ConnectNew (IPAddress, Int32): Connection
|
|
Overloaded. Opens and returns new connection with specified IP address and port.
Oxygene: method ConnectNew(host: IPAddress; port: Int32): Connection
C#: Connection ConnectNew(IPAddress host, Int32 port)
VB: Function ConnectNew(host As IPAddress, port As Int32) As Connection
Parameters:
|
| ConnectNew (String, Int32): Connection
|
|
Oxygene: method ConnectNew(hostname: String; port: Int32): Connection
C#: Connection ConnectNew(String hostname, Int32 port)
VB: Function ConnectNew(hostname As String, port As Int32) As Connection
Parameters:
|
| GetConnection protected
|
|
Oxygene: method GetConnection(host: IPAddress; port: Int32): Connection
C#: Connection GetConnection(IPAddress host, Int32 port)
VB: Function GetConnection(host As IPAddress, port As Int32) As Connection
Parameters:
|
| NewConnection protected
|
|
Oxygene: method NewConnection(binding: Binding): Connection
C#: Connection NewConnection(Binding binding)
VB: Function NewConnection(binding As Binding) As Connection
Parameters:
|
| ReleaseConnection protected
|
|
Oxygene: method ReleaseConnection(connection: Connection)
C#: void ReleaseConnection(Connection connection)
VB: Sub ReleaseConnection(connection As Connection)
Parameters:
|
| ResolveHostName protected
|
|
Oxygene: method ResolveHostName
C#: void ResolveHostName()
VB: Sub ResolveHostName
|
| ResolveHostNameIfNeeded protected
|
|
Oxygene: method ResolveHostNameIfNeeded
C#: void ResolveHostNameIfNeeded()
VB: Sub ResolveHostNameIfNeeded
|
| TriggerOnResolvedHostName protected
|
|
Oxygene: method TriggerOnResolvedHostName(hostname: String; address: IPAddress)
C#: void TriggerOnResolvedHostName(String hostname, IPAddress address)
VB: Sub TriggerOnResolvedHostName(hostname As String, address As IPAddress)
Parameters:
|
| TriggerOnResolveHostName protected
|
|
Oxygene: method TriggerOnResolveHostName(var hostname: String)
C#: void TriggerOnResolveHostName(ref String hostname)
VB: Sub TriggerOnResolveHostName(ByRef hostname As String)
Parameters:
|
Events
| OnResolvedHostName
|
|
This event is fired after the hostname has been successfully resolved.
Oxygene: event OnResolvedHostName: OnResolvedHostNameHandler
delegate: method Invoke(sender: Object; e: OnResolvedHostNameArgs)
C#: event OnResolvedHostNameHandler OnResolvedHostName
delegate: void Invoke(Object sender, OnResolvedHostNameArgs e)
VB: Event OnResolvedHostName As OnResolvedHostNameHandler
delegate: Sub Invoke(sender As Object, e As OnResolvedHostNameArgs)
|
| OnResolveHostName
|
|
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).
Oxygene: event OnResolveHostName: OnResolveHostNameHandler
delegate: method Invoke(sender: Object; e: OnResolveHostNameArgs)
C#: event OnResolveHostNameHandler OnResolveHostName
delegate: void Invoke(Object sender, OnResolveHostNameArgs e)
VB: Event OnResolveHostName As OnResolveHostNameHandler
delegate: Sub Invoke(sender As Object, e As OnResolveHostNameArgs)
|
Descendants
See Also
Glossary — Architecture — Library — Samples
