LumiSoft Net Help
TCP_Client Class
NamespacesLumiSoft.Net.TCPTCP_Client
This class implements generic TCP client.
Declaration Syntax
C#Visual BasicVisual C++F#
public class TCP_Client : TCP_Session
Public Class TCP_Client
	Inherits TCP_Session
public ref class TCP_Client : public TCP_Session
type TCP_Client =  
    class
        inherit TCP_Session
    end
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
TCP_Client()()()()
Default constructor.

AuthenticatedUserIdentity
Gets session authenticated user identity , returns null if not authenticated.
(Inherited from TCP_Session.)
BeginConnect(String, Int32, AsyncCallback, Object) Obsolete.
Starts connection to the specified host.

BeginConnect(String, Int32, Boolean, AsyncCallback, Object) Obsolete.
Starts connection to the specified host.

BeginConnect(IPEndPoint, Boolean, AsyncCallback, Object) Obsolete.
Starts connection to the specified remote end point.

BeginConnect(IPEndPoint, IPEndPoint, Boolean, AsyncCallback, Object) Obsolete.
Starts connection to the specified remote end point.

BeginDisconnect(AsyncCallback, Object)
Starts disconnecting connection.

Connect(String, Int32)
Connects to the specified host. If the hostname resolves to more than one IP address, all IP addresses will be tried for connection, until one of them connects.

Connect(String, Int32, Boolean)
Connects to the specified host. If the hostname resolves to more than one IP address, all IP addresses will be tried for connection, until one of them connects.

Connect(IPEndPoint, Boolean)
Connects to the specified remote end point.

Connect(IPEndPoint, IPEndPoint, Boolean)
Connects to the specified remote end point.

Connect(IPEndPoint, IPEndPoint, Boolean, RemoteCertificateValidationCallback)
Connects to the specified remote end point.

ConnectAsync(TCP_Client..::..ConnectAsyncOP)
Starts connecting to remote end point.

ConnectTime
Gets the time when session was connected.
(Overrides TCP_Session.ConnectTime.)
Disconnect()()()()
Disconnects connection.
(Overrides TCP_Session.Disconnect()()()().)
Dispose()()()()
Cleans up any resources being used. This method is thread-safe.
(Overrides TCP_Session.Dispose()()()().)
EndConnect(IAsyncResult) Obsolete.
Ends a pending asynchronous connection request.

EndDisconnect(IAsyncResult)
Ends a pending asynchronous disconnect request.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()()()
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
ID
Gets session ID.
(Overrides TCP_Session.ID.)
IsAuthenticated
Gets if this session is authenticated.
(Inherited from TCP_Session.)
IsConnected
Gets if TCP client is connected.
(Overrides TCP_Session.IsConnected.)
IsDisposed
Gets if this object is disposed.

IsSecureConnection
Gets if this session TCP connection is secure connection.
(Overrides TCP_Session.IsSecureConnection.)
LastActivity
Gets the last time when data was sent or received.
(Overrides TCP_Session.LastActivity.)
LocalEndPoint
Gets session local IP end point.
(Overrides TCP_Session.LocalEndPoint.)
LogAddException(String, Exception)
Logs exception.

LogAddRead(Int64, String)
Logs read operation.

LogAddText(String)
Logs free text entry.

LogAddWrite(Int64, String)
Logs write operation.

Logger
Gets or sets TCP client logger. Value null means no logging.

MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
OnConnected()()()()
This method is called after TCP client has sucessfully connected.

OnConnected(TCP_Client..::..CompleteConnectCallback)
This method is called when TCP client has sucessfully connected.

OnError(Exception) Obsolete.
This must be called when unexpected error happens. When inheriting TCP_Client class, be sure that you call OnError method for each unexpected error.

ReadLine()()()()
Reads and logs specified line from connected host.

RemoteEndPoint
Gets session remote IP end point.
(Overrides TCP_Session.RemoteEndPoint.)
SwitchToSecure()()()()
Switches session to secure connection.

SwitchToSecureAsync(TCP_Client..::..SwitchToSecureAsyncOP)
Starts switching connection to secure.

TcpStream
Gets TCP stream which must be used to send/receive data through this session.
(Overrides TCP_Session.TcpStream.)
Timeout
Gets or sets default TCP read/write timeout.

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
ValidateCertificateCallback
Gets or stes remote callback which is called when remote server certificate needs to be validated. Value null means not sepcified.

WriteLine(String)
Sends and logs specified line to connected host.

Inheritance Hierarchy

Assembly: LumiSoft.Net (Module: LumiSoft.Net.dll) Version: 4.5.5510.19119