Sylloge
A C# helper library
Public Member Functions | Properties
Sylloge.Net.TcpSocket Class Reference

Inherits Sylloge.Net.Socket.

List of all members.

Public Member Functions

 TcpSocket ()
 The default constructor.
 TcpSocket (string ipAddress, int port)
 Create an instance using a specific IP and port.
override Sylloge.Net.Socket Copy ()
 Create a deep copy of the current connection.
override void Close ()
 Closes the current TCP socket connection.
override void Connect (Socket.KeepAliveType type=KeepAliveType.NONE, byte[] msg=null, int msInterval=0)
 Connect the client.
override void Listen ()
 Initiate the listener threads for the TCP clients.
override void Send (byte[] data)
 Send data over the TCP connection.
override string ToString ()
 Returns the IP and Port of this instance.

Properties

System.Net.Sockets.TcpClient Client [get, set]
 The client to communicate on a TCP socket.
System.Net.Sockets.TcpListener Listener [get, set]
 The TCP listener used to listen on the TCP client for data.

Detailed Description

Definition at line 364 of file Socket.cs.


Constructor & Destructor Documentation

Sylloge.Net.TcpSocket.TcpSocket ( )

The default constructor.

Definition at line 378 of file Socket.cs.

Sylloge.Net.TcpSocket.TcpSocket ( string  ipAddress,
int  port 
)

Create an instance using a specific IP and port.

Parameters:
ipAddressThe IP address to use
portThe port to use

Definition at line 387 of file Socket.cs.


Member Function Documentation

override void Sylloge.Net.TcpSocket.Close ( ) [virtual]

Closes the current TCP socket connection.

Implements Sylloge.Net.Socket.

Definition at line 411 of file Socket.cs.

override void Sylloge.Net.TcpSocket.Connect ( Socket.KeepAliveType  type = KeepAliveType.NONE,
byte[]  msg = null,
int  msInterval = 0 
) [virtual]

Connect the client.

Parameters:
typeThe keep alive type to use (defualt NONE)
msgThe custom keep alive message to send (default null)
msIntervalThe interval to send custom keep alive messages at (default 0)

Implements Sylloge.Net.Socket.

Definition at line 438 of file Socket.cs.

override Sylloge.Net.Socket Sylloge.Net.TcpSocket.Copy ( ) [virtual]

Create a deep copy of the current connection.

Returns:

Reimplemented from Sylloge.Net.Socket.

Definition at line 397 of file Socket.cs.

override void Sylloge.Net.TcpSocket.Listen ( ) [virtual]

Initiate the listener threads for the TCP clients.

Implements Sylloge.Net.Socket.

Definition at line 475 of file Socket.cs.

override void Sylloge.Net.TcpSocket.Send ( byte[]  data) [virtual]

Send data over the TCP connection.

Parameters:
dataThe data to send

Implements Sylloge.Net.Socket.

Definition at line 527 of file Socket.cs.

override string Sylloge.Net.TcpSocket.ToString ( )

Returns the IP and Port of this instance.

Returns:
A string object of this instances IP and Port

Reimplemented from Sylloge.Net.Socket.

Definition at line 558 of file Socket.cs.


Property Documentation

System.Net.Sockets.TcpClient Sylloge.Net.TcpSocket.Client [get, set]

The client to communicate on a TCP socket.

Definition at line 369 of file Socket.cs.

System.Net.Sockets.TcpListener Sylloge.Net.TcpSocket.Listener [get, set]

The TCP listener used to listen on the TCP client for data.

Definition at line 373 of file Socket.cs.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties Events