GSF.Communication

Base class for a client involved in server-client communication.

Defines a client involved in server-client communication.

Connects client to the server synchronously.

Connects client to the server asynchronously.

for the asynchronous operation.

Disconnects client from the server synchronously.

Sends data to the server synchronously.

The buffer that contains the binary data to be sent. The zero-based position in the at which to begin sending data. The number of bytes to be sent from starting at the .

Sends data to the server asynchronously.

The buffer that contains the binary data to be sent. The zero-based position in the at which to begin sending data. The number of bytes to be sent from starting at the . for the asynchronous operation.

Reads a number of bytes from the current received data buffer and writes those bytes into a byte array at the specified offset.

Destination buffer used to hold copied bytes. 0-based starting index into destination to begin writing data. The number of bytes to read from current received data buffer and write into . The number of bytes read. This function should only be called from within the event handler. Calling this method outside this event will have unexpected results.

Occurs when client is attempting connection to the server.

Occurs when client connection to the server is established.

Occurs when client connection to the server is terminated.

Occurs when an is encountered during connection attempt to the server.

Occurs when the client begins sending data to the server.

Occurs when the client has successfully sent data to the server.

Occurs when an is encountered when sending data to the server.

is the encountered when sending data to the server.

Occurs when unprocessed data has been received from the server.

This event can be used to receive a notification that server data has arrived. The method can then be used to copy data to an existing buffer. In many cases it will be optimal to use an existing buffer instead of subscribing to the event, however, the data that is available after calling the method will be the original unprocessed data received by the client, i.e., not optionally decrypted or decompressed data. is the number of bytes received in the buffer from the server.

Occurs when data received from the server has been processed and is ready for consumption.

is a new buffer containing post-processed data received from the server starting at index zero.
is the number of post-processed bytes received in the buffer from the server.

Occurs when an is encountered when receiving data from the server.

is the encountered when receiving data from the server.

Occurs when an is encountered in a user-defined function via an event dispatch.

is the thrown by the user-defined function.

Gets or sets the data required by the client to connect to the server.

Gets or sets the maximum number of times the client will attempt to connect to the server.

Gets or sets the size of the buffer used by the client for receiving data from the server.

Gets or sets the to be used for the text sent to the server.

Gets the server URI.

Gets the current .

Gets the used by the client for the transportation of data with the server.

Gets the for which the client has been connected to the server.

Specifies the default value for the property.

Initializes a new instance of the client.

One of the values. The data used by the client for connection to a server.

When overridden in a derived class, reads a number of bytes from the current received data buffer and writes those bytes into a byte array at the specified offset.

When overridden in a derived class, validates the specified .

The connection string to be validated.

When overridden in a derived class, sends data to the server asynchronously.

Initializes the client.

is to be called by user-code directly only if the client is not consumed through the designer surface of the IDE.

Performs necessary operations before the client properties are initialized.

should never be called by user-code directly. This method exists solely for use by the designer if the server is consumed through the designer surface of the IDE.

Performs necessary operations after the client properties are initialized.

should never be called by user-code directly. This method exists solely for use by the designer if the server is consumed through the designer surface of the IDE.

Saves client settings to the config file if the property is set to true.

has a value of null or empty string.

Loads saved client settings from the config file if the property is set to true.

has a value of null or empty string.

Connects the client to the server synchronously.

Connects the client to the server asynchronously.

Server property in is invalid. Attempt is made to connect the client when it is not disconnected. for the asynchronous operation. Derived classes are expected to override this method with protocol specific connection operations. Call the base class method to obtain an operational wait handle if protocol connection operation doesn't provide one already.

Sends data to the server synchronously.

The plain-text data that is to be sent.

Sends data to the server synchronously.

The serializable object that is to be sent.

Sends data to the server synchronously.

The binary data that is to be sent.

Sends data to the server synchronously.

The buffer that contains the binary data to be sent. The zero-based position in the at which to begin sending data. The number of bytes to be sent from starting at the .

Sends data to the server asynchronously.

The plain-text data that is to be sent. for the asynchronous operation.

Sends data to the server asynchronously.

The serializable object that is to be sent. for the asynchronous operation.

Sends data to the server asynchronously.

The binary data that is to be sent. for the asynchronous operation.

Sends data to the server asynchronously.

When overridden in a derived class, disconnects client from the server synchronously.

Raises the event.

Exception to send to event.

Raises the event.

Exception to send to event.

Raises the event.

Number of bytes received from the client. This event is automatically raised by call to so that inheritors never need to worry about raising this event. This method is only included here in case any custom client implementations need to explicitly raise this event.

Raises the event.

Data received from the client. Number of bytes received from the client.

Raises the event.

Exception to send to event.

Raises the event.

Exception to send to event.

Releases the unmanaged resources used by the client and optionally releases the managed resources.

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Re-connects the client if currently connected.

Create a communications client

Note that typical connection string should be prefixed with a "protocol=tcp", "protocol=udp", "protocol=serial" or "protocol=file" A communications client. Connection string for the client.

Occurs when client is attempting connection to the server.

Occurs when client connection to the server is established.

Occurs when client connection to the server is terminated.

Occurs when an is encountered during connection attempt to the server.

Occurs when the client begins sending data to the server.

Occurs when the client has successfully sent data to the server.

Occurs when an is encountered when sending data to the server.

is the encountered when sending data to the server.

Occurs when unprocessed data has been received from the server.

Occurs when data received from the server has been processed and is ready for consumption.

is a new buffer containing post-processed data received from the server starting at index zero.
is the number of post-processed bytes received in the buffer from the server.

Occurs when an is encountered when receiving data from the server.

is the encountered when receiving data from the server.

Occurs when an is encountered in a user-defined function via an event dispatch.

is the thrown by the user-defined function.

Gets the server URI.

Gets or sets the data required by the client to connect to the server.

Gets or sets the maximum number of times the client will attempt to connect to the server.

Set to -1 for infinite connection attempts.

Gets or sets the size of the buffer used by the client for sending data to the server.

The value being assigned is either zero or negative.

Gets or sets the size of the buffer used by the client for receiving data from the server.

The value being assigned is either zero or negative.

Gets or sets a boolean value that indicates whether the client settings are to be saved to the config file.

Gets or sets the category under which the client settings are to be saved to the config file if the property is set to true.

The value being assigned is a null or empty string.

Gets or sets a boolean value that indicates whether the client is currently enabled.

Setting to true will start connection cycle for the client if it is not connected, setting to false will disconnect the client if it is connected.

Gets or sets the to be used for the text sent to the server.

Gets the current .

Gets the used by the client for the transportation of data with the server.

Gets the for which the client has been connected to the server.

Gets or sets current read index for received data buffer incremented at each call.

Gets the unique identifier of the client.

Gets the descriptive status of the client.

Represents a communication client based on .

This example shows how to use for writing data to a file:


            using System;
            using GSF.Communication;
            
            class Program
            {
                static FileClient s_client;
            
                static void Main(string[] args)
                {
                    // Initialize the client.
                    s_client = new FileClient(@"File=c:\File.txt");
                    s_client.Initialize();
                    // Register event handlers.
                    s_client.ConnectionAttempt += s_client_ConnectionAttempt;
                    s_client.ConnectionEstablished += s_client_ConnectionEstablished;
                    s_client.ConnectionTerminated += s_client_ConnectionTerminated;
                    s_client.SendDataComplete += s_client_SendDataComplete;
                    // Connect the client.
                    s_client.Connect();
            
                    // Write user input to the file.
                    string input;
                    while (string.Compare(input = Console.ReadLine(), "Exit", true) != 0)
                    {
                        s_client.Send(input + "\r\n");
                    }
            
                    // Disconnect the client on shutdown.
                    s_client.Dispose();
                }
            
                static void s_client_ConnectionAttempt(object sender, EventArgs e)
                {
                    Console.WriteLine("Client is connecting to file.");
                }
            
                static void s_client_ConnectionEstablished(object sender, EventArgs e)
                {
                    Console.WriteLine("Client connected to file.");
                }
            
                static void s_client_ConnectionTerminated(object sender, EventArgs e)
                {
                    Console.WriteLine("Client disconnected from file.");
                }
            
                static void s_client_SendDataComplete(object sender, EventArgs e)
                {
                    Console.WriteLine(string.Format("Sent data - {0}", s_client.TextEncoding.GetString(s_client.Client.SendBuffer)));
                }
            }

This example shows how to use for reading data to a file:


            using System;
            using GSF;
            using GSF.Communication;
            
            class Program
            {
                static FileClient s_client;
            
                static void Main(string[] args)
                {
                    // Initialize the client.
                    s_client = new FileClient(@"File=c:\File.txt");
                    s_client.Initialize();
                    // Register event handlers.
                    s_client.ConnectionAttempt += s_client_ConnectionAttempt;
                    s_client.ConnectionEstablished += s_client_ConnectionEstablished;
                    s_client.ConnectionTerminated += s_client_ConnectionTerminated;
                    s_client.ReceiveDataComplete += s_client_ReceiveDataComplete;
                    // Connect the client.
                    s_client.Connect();
            
                    // Wait for client to read data.
                    Console.ReadLine();
            
                    // Disconnect the client on shutdown.
                    s_client.Dispose();
                }
            
                static void s_client_ConnectionAttempt(object sender, EventArgs e)
                {
                    Console.WriteLine("Client is connecting to file.");
                }
            
                static void s_client_ConnectionEstablished(object sender, EventArgs e)
                {
                    Console.WriteLine("Client connected to file.");
                }
            
                static void s_client_ConnectionTerminated(object sender, EventArgs e)
                {
                    Console.WriteLine("Client disconnected from file.");
                }
            
                static void s_client_ReceiveDataComplete(object sender, EventArgs<byte[], int> e)
                {
                    Console.WriteLine(string.Format("Received data - {0}", s_client.TextEncoding.GetString(e.Argument1, 0, e.Argument2)));
                }
            }

Specifies the default value for the property.

Initializes a new instance of the class.

Connect string of the . See for format.

Initializes a new instance of the class.

object that contains the .

Reads a number of bytes from the current received data buffer and writes those bytes into a byte array at the specified offset.

Reads next data buffer from the .

is called when is not connected. is called when is disabled.

Disconnects the from the .

Connects the to the asynchronously.

Attempt is made to connect the when it is not disconnected. for the asynchronous operation.

Saves settings to the config file if the property is set to true.

Loads saved settings from the config file if the property is set to true.

Releases the unmanaged resources used by the and optionally releases the managed resources.

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Validates the specified .

Connection string to be validated. File property is missing.

Sends (writes) data to the file asynchronously.

The buffer that contains the binary data to be sent (written). The zero-based position in the at which to begin sending (writing) data. The number of bytes to be sent (written) from starting at the . for the asynchronous operation.

Callback method for asynchronous send operation.

Connects to the .

Receive (reads) data from the .

Gets or sets a boolean value that indicates whether receiving (reading) of data is to be repeated endlessly.

is enabled when is

Gets or sets a boolean value that indicates whether receiving (reading) of data will be initiated manually by calling .

will be set to -1 when is enabled.

Gets or sets the number of milliseconds to pause before receiving (reading) the next available set of data.

Set = -1 to receive (read) data continuously without pausing.

Gets or sets the starting point relative to the beginning of the file from where the data is to be received (read).

The value being assigned is not a positive number.

Gets or sets the value to be used when opening the file.

Gets or set the value to be used when opening the file.

Gets or sets the value to be used when opening the file.

is set to when is enabled.

Gets the object for the .

Gets the server URI of the .

Indicates the current state of the client.

Client is establishing connection.

Client has established connection.

Client connection is terminated.

Indicates the current state of the server.

Server is running.

Server is not running.

Defines a server involved in server-client communication.

Starts the server.

Stops the server.

Disconnects all of the connected clients.

Disconnects a connected client.

ID of the client to be disconnected.

Sends data to the specified client synchronously.

ID of the client to which the data is to be sent. The buffer that contains the binary data to be sent. The zero-based position in the at which to begin sending data. The number of bytes to be sent from starting at the .

Sends data to all of the connected clients synchronously.

The buffer that contains the binary data to be sent. The zero-based position in the at which to begin sending data. The number of bytes to be sent from starting at the .

Sends data to the specified client asynchronously.

Sends data to all of the connected clients asynchronously.

The buffer that contains the binary data to be sent. The zero-based position in the at which to begin sending data. The number of bytes to be sent from starting at the . Array of for the asynchronous operation.

Reads a number of bytes from the current received data buffer and writes those bytes into a byte array at the specified offset.

ID of the client from which data buffer should be read. Destination buffer used to hold copied bytes. 0-based starting index into destination to begin writing data. The number of bytes to read from current received data buffer and write into . The number of bytes read. This function should only be called from within the event handler. Calling this method outside this event will have unexpected results.

Occurs when the server is started.

Occurs when the server is stopped.

Occurs when a client connects to the server.

is the ID of the client that connected to the server.

Occurs when a client disconnects from the server.

is the ID of the client that disconnected from the server.

Occurs when an exception is encountered while a client is connecting.

is the encountered when connecting to the client.

Occurs when data is being sent to a client.

is the ID of the client to which the data is being sent.

Occurs when data has been sent to a client.

is the ID of the client to which the data has been sent.

Occurs when an is encountered when sending data to a client.

is the ID of the client to which the data was being sent.
is the encountered when sending data to a client.

Occurs when unprocessed data has been received from a client.

This event can be used to receive a notification that client data has arrived. The method can then be used to copy data to an existing buffer. In many cases it will be optimal to use an existing buffer instead of subscribing to the event, however, the data that is available after calling the method will be the original unprocessed data received by the client, i.e., not optionally decrypted or decompressed data. is the ID of the client from which data is received.
is the number of bytes received in the buffer from the client.

Occurs when data received from a client has been processed and is ready for consumption.

is the ID of the client from which data is received.
is a new buffer containing post-processed data received from the client starting at index zero.
is the number of post-processed bytes received in the buffer from the client.

Occurs when an is encountered when receiving data from a client.

is the ID of the client from which the data was being received.
is the encountered when receiving data from a client.

Occurs when an is encountered in a user-defined function via an event dispatch.

is the thrown by the user-defined function.

Gets or sets the data required by the server to initialize.

Gets or sets the maximum number of clients that can connect to the server.

Gets or sets the size of the buffer used by the client for receiving data from the server.

Gets or sets the size of the buffer used by the server for receiving data from the clients.

Gets or sets the to be used for the text sent to the connected clients.

Gets the current .

Gets the used by the server for the transportation of data with the clients.

Gets the server's ID.

Gets the IDs of clients connected to the server.

Gets the for which the server has been running.

Contains high-level classes and components related to any data communications including sockets, serial and file based transports used to simplify and standardize data access.

A helper class containing methods for manipulation of payload.

Specifies the length of the segment in a "Payload-Aware" transmission that contains the payload length.

Default byte sequence used to mark the beginning of the payload in a "Payload-Aware" transmissions.

Adds header containing the to the payload in the for "Payload-Aware" transmission.

The buffer containing the payload. The offset in the at which the payload starts. The lenght of the payload in the starting at the . The byte sequence used to mark the beginning of the payload in a "Payload-Aware" transmissions.

Determines whether or not the contains the header information of a "Payload-Aware" transmission.

The buffer to be checked at index zero. The byte sequence used to mark the beginning of the payload in a "Payload-Aware" transmissions. true if the buffer contains "Payload-Aware" transmission header; otherwise false.

Determines the length of a payload in a "Payload-Aware" transmission from the payload header information.

The buffer containg payload header information starting at index zero. The length of valid data within in . The byte sequence used to mark the beginning of the payload in a "Payload-Aware" transmissions. Length of the payload.

Contains classes for RADIUS (Remote Authentication Dial In User Service) based server and client communication.

Represents a RADIUS communication client.

Default port of the RADIUS server.

Default text for comparing with the text of ReplyMessage attribute in an AccessChallenge server response to determine whether or not Step 1 (ensuring that the user account is in the "New Pin" mode) of creating a new pin was successful.

Default text for comparing with the text of ReplyMessage attribute in an AccessChallenge server response to determine whether or not Step 2 (new pin is accepted in attempt #1) of creating a new pin was successful.

Default text for comparing with the text of ReplyMessage attribute in an AccessChallenge server response to determine whether or not Step 3 (new pin is accepted in attempts #2) of creating a new pin was successful.

Default text for comparing with the text of ReplyMessage attribute in an AccessChallenge server response to determine whether or not a user account is in the "Next Token" mode.

Creates an instance of RADIUS client for sending request to a RADIUS server.

Name or address of the RADIUS server. Shared secret used for encryption and authentication.

Creates an instance of RADIUS client for sending request to a RADIUS server.

Name or address of the RADIUS server. Port number of the RADIUS server. Shared secret used for encryption and authentication.

Send a request to the server and waits for a response back.

Request to be sent to the server. Response packet if a valid response is received from the server; otherwise Nothing.

Create a new pin for the user.

Name of the user. Current token of the user. New pin of the user. True if a new pin is created for the user successfully; otherwise False. NOTE: This method is specific to RSA RADIUS implementation.

Authenticates the username and password against the RADIUS server.

Username to be authenticated. Password to be authenticated. Response packet received from the server for the authentication request. The type of response packet (if any) will be one of the following: AccessAccept: If the authentication is successful. AccessReject: If the authentication is not successful. AccessChallenge: If the server need more information from the user. When an AccessChallenge response packet is received from the server, it contains a State attribute that must be included in the AccessRequest packet that is being sent in response to the AccessChallenge response. So if this method returns an AccessChallenge packet, then this method is to be called again with the requested information (from ReplyMessage attribute) in the password field and the value State attribute.

Authenticates the username and password against the RADIUS server.

Username to be authenticated. Password to be authenticated. State value from a previous challenge response. Response packet received from the server for the authentication request. The type of response packet (if any) will be one of the following: AccessAccept: If the authentication is successful. AccessReject: If the authentication is not successful. AccessChallenge: If the server need more information from the user. When an AccessChallenge response packet is received from the server, it contains a State attribute that must be included in the AccessRequest packet that is being sent in response to the AccessChallenge response. So if this method returns an AccessChallenge packet, then this method is to be called again with the requested information (from ReplyMessage attribute) in the password field and the value State attribute.

Determines whether or not the response indicates that the user account is in "New Pin" mode.

Response packet sent by the server. True if the user account is in "New Pin" mode; otherwise False. A user's account can be in the "New Pin" mode when set on the server. NOTE: This method is specific to RSA RADIUS implementation.

Determines whether or not the response indicates that the user account is in "Next Token" mode.

Response packet sent by the server. True if the user account is in "Next Token" mode; otherwise False. A user's account can enter the "Next Token" mode after the user enters incorrect passwords for a few times (3 times by default) and then enters the correct password. Note that repeatedly entering incorrect passwords will disable the user account. NOTE: This method is specific to RSA RADIUS implementation.

Releases the used resources.

Helper method to check whether or not the object instance has been disposed.

This method is to be called before performing any operation.

Releases the used resources.

Gets or sets the name or address of the RADIUS server.

Name or address of RADIUS server.

Gets or sets the port number of the RADIUS server.

Port number of the RADIUS server.

Gets or sets the number of time a request is to sent to the server until a valid response is received.

Number of time a request is to sent to the server until a valid response is received.

Gets or sets the time (in milliseconds) to wait for a response from server after sending a request.

Time (in milliseconds) to wait for a response from server after sending a request.

Gets or sets the shared secret used between the client and server for encryption and authentication.

Shared secret used between the client and server for encryption and authentication.

Gets or sets the text for comparing with the text of ReplyMessage attribute in an AccessChallenge server response to determine whether or not Step 1 (ensuring that the user account is in the "New Pin" mode) of creating a new pin was successful.

Text for "New Pin" mode's first message.

Gets or sets the text for comparing with the text of ReplyMessage attribute in an AccessChallenge server response to determine whether or not Step 2 (new pin is accepted in attempt #1) of creating a new pin was successful.

Text for "New Pin" mode's second message.

Gets or sets the text for comparing with the text of ReplyMessage attribute in an AccessChallenge server response to determine whether or not Step 3 (new pin is accepted in attempts #2) of creating a new pin was successful.

Text for "New Pin" mode's third message.

Gets or sets the text for comparing with the text of ReplyMessage attribute in an AccessChallenge server response to determine whether or not a user account is in the "Next Token" mode.

Text for "Next Token" mode.

Specifies the type of the .

Packet sent to a RADIUS server for verification of credentials.

Packet sent by a RADIUS server when credential verification is successful.

Packet sent by a RADIUS server when credential verification is unsuccessful.

Not used. No description available. [RFC 2882]

Packet sent by a RADIUS server when further information is needed for credential verification.

Not used. No description available. [RFC 2882]

Represents a data packet transferred between RADIUS client and server.

Initializes a new instance of the class.

Type of the .

Initializes a new instance of the class.

Binary image to be used for initializing . 0-based starting index of initialization data in the . Valid number of bytes in from .

Parses object by parsing the specified containing a binary image.

Buffer containing binary image to parse. 0-based starting index in the to start parsing. Valid number of bytes within from . The number of bytes used for initialization in the (i.e., the number of bytes parsed), or 0 if not enough data. is null.

Generates a binary representation of this object and copies it into the given buffer.

Buffer used to hold generated binary image of the source object. 0-based starting index in the to start writing. The number of bytes written to the . is null. or is less than 0 -or- and will exceed length.

Gets the value of the specified if it is present in the .

of the whose value is to be retrieved. . if is present; otherwise null.

format for encoding text.

to use for byte conversion.

Generates an "Authenticator" value used in a RADIUS request packet sent by the client to server.

The shared secret to be used in generating the output. A byte array.

Generates an "Authenticator" value used in a RADIUS response packet sent by the server to client.

The shared secret key. RADIUS packet sent from client to server. RADIUS packet sent from server to client. A byte array.

Generates an encrypted password using the RADIUS protocol specification (RFC 2285).

User's password. Shared secret key. Request authenticator byte array. A byte array.

Gets or sets the type of the .

Gets or sets the identifier.

Gets or sets the authenticator.

The value being assigned is null. The value being assigned is not 16-bytes in length.

Gets a list of s.

Gets the length of the .

Specifies the type of .

Attribute indicates the name of the user to be authenticated.

Attribute indicates the password of the user to be authenticated.

Attribute indicates the response provided by a PPP CHAP user in reponse to the challenge.

Attribute indicates the identifying IP address of the NAS requesting user authentication.

Attribute indicates the physical port number of the NAS which is authenticating the user.

Attribute indicates the type of service the user has requested, or the type of service to be provided.

Attribute indicates the framing to be used for framed access.

Attribute indicates the address to be configured for the user.

Attribute indicates the IP netmask to be configured for the user when user is a router to a network.

Attribute indicates the routing method for the user when user is a router to a network.

Attribute indicates the name of the filter list for this user.

Attribute indicates the MTU to be configured for the user when it is not negotiated by some other means.

Attribute indicates a compression protocol to be used for the link.

Attribute indicates the system with which to connect the user when attribute is included.

Attribute indicates the service to use to connect the user to the login host.

Attribute indicates the TCP port with which the user is to be connected when attribute is included.

Attribute indicates the text which may be displayed to the user.

Attribute indicates a dialing string to be used for callback.

Attribute indicates the name of a place to be called.

Attribute provides routing information to be configured for the user on the NAS.

Attribute indicates the IPX Network number to be configured for the user.

Attribute available to be sent by the server to the client in an and must be sent unmodified from the client to the server in the new reply to the challenge.

Attribute available to be sent by the server to the client in an and should be sent unmodified by the client to the accounting server as part of the .

Attribute available to allow vendors to support their own extended attributes.

Attribute sets the maximum number of seconds of service to be provided to the user before termination of the session or prompt.

Attribute sets the maximum number of consecutive seconds of idle connection allowed to the user before termination of the session or prompt.

Attribute indicates the action the NAS should take when the specified service is complete.

Attribute indicates the phone number that the user called using DNIS or similar technology.

Attribute indicates the phone number the call came from using ANI or similar technology.

Attribute indicates a string identifier for the NAS originating the AccessRequest.

Attribute indicates the state a proxy server forwarding requests to the server.

Attribute indicates the system with which the user is to be connected by LAT.

Attribute indicates the Node with which the user is to be automatically connected by LAT.

Attribute indicates the string identifier for the LAT group codes which the user is authorized to use.

Attribute indicates the AppleTalk network number which should be used for the serial link to the user.

Attribute indicates the AppleTalk Network number which the NAS should probe to allocate an AppleTalk node for the user.

Attribute indicates the AppleTalk Default Zone to be used for this user.

Attribute contains the CHAP Challenge sent by the NAS to a PPP CHAP user.

Attribute indicates the type of physical port of the NAS which is authenticating the user.

Attribute sets the maximum number of ports to be provided to the user by the NAS.

Attribute indicates the Port with which the user is to be connected by the LAT.

Represents an attribute of .

Initializes a new instance of the class.

Type of the . Text value of the .

Initializes a new instance of the class.

Type of the . 32-bit unsigned integer value of the .

Initializes a new instance of the class.

Type of the . IP address value of the .

Initializes a new instance of the class.

Type of the . Byte array value of the .

Initializes a new instance of the class.

Buffer containing binary image to be used for initializing . 0-based starting index of initialization data in the . Valid number of bytes in from .

Parses object by parsing the specified containing a binary image.

Generates a binary representation of this object and copies it into the given buffer.

Gets or sets the type of the .

Gets or sets the value of the .

The value being assigned is null or zero-length byte array.

Gets the length of the .

Represents a communication client based on .

This example shows how to use for communicating with :


            using System;
            using GSF;
            using GSF.Communication;
            
            class Program
            {
                static SerialClient s_client;
            
                static void Main(string[] args)
                {
                    // Initialize the client.
                    s_client = new SerialClient("Port=COM1; BaudRate=9600; Parity=None; StopBits=One; DataBits=8; DtrEnable=False; RtsEnable=False");
                    s_client.Initialize();
                    // Register event handlers.
                    s_client.ConnectionAttempt += s_client_ConnectionAttempt;
                    s_client.ConnectionEstablished += s_client_ConnectionEstablished;
                    s_client.ConnectionTerminated += s_client_ConnectionTerminated;
                    s_client.SendDataComplete += s_client_SendDataComplete;
                    s_client.ReceiveDataComplete += s_client_ReceiveDataComplete;
                    // Connect the client.
                    s_client.Connect();
            
                    // Write user input to the serial port.
                    string input;
                    while (string.Compare(input = Console.ReadLine(), "Exit", true) != 0)
                    {
                        s_client.Send(input);
                    }
            
                    // Disconnect the client on shutdown.
                    s_client.Dispose();
                }
            
                static void s_client_ConnectionAttempt(object sender, EventArgs e)
                {
                    Console.WriteLine("Client is connecting to serial port.");
                }
            
                static void s_client_ConnectionEstablished(object sender, EventArgs e)
                {
                    Console.WriteLine("Client connected to serial port.");
                }
            
                static void s_client_ConnectionTerminated(object sender, EventArgs e)
                {
                    Console.WriteLine("Client disconnected from serial port.");
                }
            
                static void s_client_SendDataComplete(object sender, EventArgs e)
                {
                    Console.WriteLine(string.Format("Sent data - {0}", s_client.TextEncoding.GetString(s_client.Client.SendBuffer)));
                }
            
                static void s_client_ReceiveDataComplete(object sender, EventArgs<byte[], int> e)
                {
                    Console.WriteLine(string.Format("Received data - {0}", s_client.TextEncoding.GetString(e.Argument1, 0, e.Argument2)));
                }
            }

Specifies the default value for the property.

Initializes a new instance of the class.

Connect string of the . See for format.

Initializes a new instance of the class.

object that contains the .

Reads a number of bytes from the current received data buffer and writes those bytes into a byte array at the specified offset.

Disconnects the from the .

Connects the to the asynchronously.

Attempt is made to connect the when it is connected. for the asynchronous operation.

Releases the unmanaged resources used by the and optionally releases the managed resources.

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Validates the specified .

Connection string to be validated. Port property is missing. BaudRate property is missing. Parity property is missing. StopBits property is missing. DataBits property is missing.

Sends (writes) data to the asynchronously.

Callback method for asynchronous send operation.

Connects to the .

Receive (read) data from the (.NET serial port class raises this event when data is available).

Receive (read) error data from the (.NET serial port class raises this event when error occurs).

Gets the object for the .

Gets the server URI of the .

Gets or sets the needed number of bytes in the internal input buffer before a event occurs.

This option is ignored under Mono deployments.

Base class for a server involved in server-client communication.

Specifies the default value for the property.

Initializes a new instance of the server.

One of the values. The data used by the server for initialization.

When overridden in a derived class, starts the server.

When overridden in a derived class, stops the server.

When overridden in a derived class, reads a number of bytes from the current received data buffer and writes those bytes into a byte array at the specified offset.

When overridden in a derived class, disconnects a connected client.

ID of the client to be disconnected.

When overridden in a derived class, validates the specified .

The configuration string to be validated.

When overridden in a derived class, sends data to the specified client asynchronously.

Initializes the server.

is to be called by user-code directly only if the server is not consumed through the designer surface of the IDE.

Performs necessary operations before the server properties are initialized.

should never be called by user-code directly. This method exists solely for use by the designer if the server is consumed through the designer surface of the IDE.

Performs necessary operations after the server properties are initialized.

should never be called by user-code directly. This method exists solely for use by the designer if the server is consumed through the designer surface of the IDE.

Saves server settings to the config file if the property is set to true.

has a value of null or empty string.

Loads saved server settings from the config file if the property is set to true.

has a value of null or empty string.

Sends data to the specified client synchronously.

ID of the client to which the data is to be sent. The plain-text data that is to be sent.

Sends data to the specified client synchronously.

ID of the client to which the data is to be sent. The serializable object that is to be sent.

Sends data to the specified client synchronously.

ID of the client to which the data is to be sent. The binary data that is to be sent.

Sends data to the specified client synchronously.

Sends data to all of the connected clients synchronously.

The plain-text data that is to be sent.

Sends data to all of the connected clients synchronously.

The serializable object that is to be sent.

Sends data to all of the connected clients synchronously.

The binary data that is to be sent.

Sends data to all of the connected clients synchronously.

The buffer that contains the binary data to be sent. The zero-based position in the at which to begin sending data. The number of bytes to be sent from starting at the .

Disconnects all of the connected clients.

Sends data to the specified client asynchronously.

ID of the client to which the data is to be sent. The plain-text data that is to be sent. for the asynchronous operation.

Sends data to the specified client asynchronously.

ID of the client to which the data is to be sent. The serializable object that is to be sent. for the asynchronous operation.

Sends data to the specified client asynchronously.

ID of the client to which the data is to be sent. The binary data that is to be sent. for the asynchronous operation.

Sends data to the specified client asynchronously.

Sends data to all of the connected clients asynchronously.

The plain-text data that is to be sent. Array of for the asynchronous operation.

Sends data to all of the connected clients asynchronously.

The serializable object that is to be sent. Array of for the asynchronous operation.

Sends data to all of the connected clients asynchronously.

The binary data that is to be sent. Array of for the asynchronous operation.

Sends data to all of the connected clients asynchronously.

Raises the event.

ID of client to send to event.

Raises the event.

ID of client to send to event.

Raises the event.

The encountered when connecting to the client.

Raises the event.

ID of client to send to event.

Raises the event.

ID of client to send to event.

Raises the event.

ID of client to send to event. Exception to send to event.

Raises the event.

ID of the client from which data is received. Number of bytes received from the client. This event is automatically raised by call to so that inheritors never need to worry about raising this event. This method is only included here in case any custom server implementations need to explicitly raise this event.

Raises the event.

ID of the client from which data is received. Data received from the client. Number of bytes received from the client.

Raises the event.

ID of client to send to event. Exception to send to event.

Raises the event.

Exception to send to event.

Releases the unmanaged resources used by the server and optionally releases the managed resources.

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Re-starts the server if currently running.

Create a communications server

Note that typical configuration string should be prefixed with a "protocol=tcp" or a "protocol=udp" The configuration string for the server. A communications server.

Occurs when the server is started.

Occurs when the server is stopped.

Occurs when a client connects to the server.

is the ID of the client that connected to the server.

Occurs when a client disconnects from the server.

is the ID of the client that disconnected from the server.

Occurs when an exception is encountered while a client is connecting.

is the encountered when connecting to the client.

Occurs when data is being sent to a client.

is the ID of the client to which the data is being sent.

Occurs when data has been sent to a client.

is the ID of the client to which the data has been sent.

Occurs when an is encountered when sending data to a client.

is the ID of the client to which the data was being sent.
is the encountered when sending data to a client.

Occurs when unprocessed data has been received from a client.

Occurs when data received from a client has been processed and is ready for consumption.

Occurs when an is encountered when receiving data from a client.

is the ID of the client from which the data was being received.
is the encountered when receiving data from a client.

Occurs when an is encountered in a user-defined function via an event dispatch.

is the thrown by the user-defined function.

Gets or sets the data required by the server to initialize.

Gets or sets the maximum number of clients that can connect to the server.

Set to -1 to allow infinite client connections.

Gets or sets the size of the buffer used by the server for sending data to the clients.

The value being assigned is either zero or negative.

Gets or sets the size of the buffer used by the server for receiving data from the clients.

The value being assigned is either zero or negative.

Gets or sets a boolean value that indicates whether the server settings are to be saved to the config file.

Gets or sets the category under which the server settings are to be saved to the config file if the property is set to true.

The value being assigned is a null or empty string.

Gets or sets a boolean value that indicates whether the server is currently enabled.

Setting to true will start the server if it is not running, setting to false will stop the server if it is running.

Gets or sets the to be used for the text sent to the connected clients.

Gets the current .

Gets the used by the server for the transportation of data with the clients.

Gets the server's ID.

Gets the IDs of clients connected to the server.

Gets the for which the server has been running.

Gets current read indices for received data buffers incremented at each call.

Gets the unique identifier of the server.

Gets the descriptive status of the server.

Gets a boolean value that indicates whether the server has been initialized.

Represents a TCP-based communication client with SSL authentication and encryption.

Specifies the default value for the property.

Initializes a new instance of the class.

Connect string of the . See for format.

Initializes a new instance of the class.

object that contains the .

When overridden in a derived class, reads a number of bytes from the current received data buffer and writes those bytes into a byte array at the specified offset.

Saves settings to the config file if the property is set to true.

Loads saved settings from the config file if the property is set to true.

When overridden in a derived class, disconnects client from the server synchronously.

Connects the to the server asynchronously.

Attempt is made to connect the when it is not disconnected. for the asynchronous operation.

Releases the unmanaged resources used by the and optionally releases the managed resources.

true to release both managed and unmanaged resources; false to release only unmanaged resources.

When overridden in a derived class, validates the specified .

The connection string to be validated.

When overridden in a derived class, sends data to the server asynchronously.

Raises the event.

Exception to send to event.

Raises the event.

Exception to send to event.

Raises the event.

Exception to send to event.

Callback method for asynchronous connect operation.

Callback method for asynchronous authenticate operation.

Sends a payload on the socket.

Callback method for asynchronous send operation.

Initiate method for asynchronous receive operation of payload data.

Initiate method for asynchronous receive operation of payload data in "payload-aware" mode.

Callback method for asynchronous receive operation of payload data in "payload-aware" mode.

Initiate method for asynchronous receive operation of payload data in "payload-unaware" mode.

Callback method for asynchronous receive operation of payload data in "payload-unaware" mode.

Processes the termination of client.

Returns the certificate set by the user.

Loads the list of trusted certificates into the default certificate checker.

Gets or sets a boolean value that indicates whether the payload boundaries are to be preserved during transmission.

Gets or sets the byte sequence used to mark the beginning of a payload in a transmission.

The value being assigned is null or empty buffer.

Gets or sets a boolean value that indicates whether the current Windows account credentials are used for authentication.

This option is ignored under Mono deployments.

Gets or sets a boolean value that indicates whether the server should ignore errors when the client's credentials are invalid.

This property should only be set to true if there is an alternative by which to authenticate the client when integrated security fails.

Gets or sets a boolean value that determines if dual-mode socket is allowed when endpoint address is IPv6.

Gets or sets the maximum size for the send queue before payloads are dumped from the queue.

Gets the object for the .

Gets the server URI of the .

Gets or sets network credential that is used when is set to true.

Gets or sets the certificate checker used to validate remote certificates.

The certificate checker will only be used to validate certificates if the is set to null.

Gets or sets the callback used to verify remote certificates.

Setting this property overrides the validation callback in the .

Gets or sets the callback used to select a local certificate.

Gets the collection of X509 certificates for this client.

Gets or sets a set of flags which determine the enabled .

Gets or sets a boolean value that determines whether the certificate revocation list is checked during authentication.

Gets or sets the path to the certificate used for authentication.

Gets or sets the local certificate selected by the default .

Gets or sets the path to the directory containing the trusted certificates.

Gets or sets the set of valid policy errors when validating remote certificates.

Gets or sets the set of valid chain flags used when validating remote certificates.

Represents a TCP-based communication server with SSL authentication and encryption.

Specifies the default value for the property.

Initializes a new instance of the class.

Config string of the . See for format.

Initializes a new instance of the class.

object that contains the .

Reads a number of bytes from the current received data buffer and writes those bytes into a byte array at the specified offset.

Saves settings to the config file if the property is set to true.

Loads saved settings from the config file if the property is set to true.

Stops the synchronously and disconnects all connected clients.

Starts the synchronously and begins accepting client connections asynchronously.

Attempt is made to the when it is running.

Disconnects the specified connected client.

ID of the client to be disconnected. Client does not exist for the specified .

Gets the object associated with the specified client ID.

ID of the client. The TLS client. An object. Client does not exist for the specified .

Gets the object associated with the specified client ID.

ID of the client. The principal of the client. A object.

Validates the specified .

Configuration string to be validated. Port property is missing. Port property value is not between and .

Sends data to the specified client asynchronously.

Callback method for asynchronous accept operation.

Callback method for asynchronous authenticate operation.

Asynchronous loop sends payloads on the socket.

Callback method for asynchronous send operation.

Initiate method for asynchronous receive operation of payload data.

Initiate method for asynchronous receive operation of payload data in "payload-aware" mode.

Callback method for asynchronous receive operation of payload data in "payload-aware" mode.

Initiate method for asynchronous receive operation of payload data in "payload-unaware" mode.

Callback method for asynchronous receive operation of payload data in "payload-unaware" mode.

Processes the termination of client.

Returns the certificate set by the user.

Loads the list of trusted certificates into the default certificate checker.

Gets or sets a boolean value that indicates whether the payload boundaries are to be preserved during transmission.

Gets or sets the byte sequence used to mark the beginning of a payload in a transmission.

The value being assigned is null or empty buffer.

Gets or sets a boolean value that indicates whether the client Windows account credentials are used for authentication.

This option is ignored under Mono deployments.

Gets or sets a boolean value that indicates whether the server should ignore errors when the client's credentials are invalid.

This property should only be set to true if there is an alternative by which to authenticate the client when integrated security fails. When this is set to true, if the client's credentials are invalid, the method will return true for that client, but the principal will still be null.

Gets or sets a boolean value that determines if dual-mode socket is allowed when endpoint address is IPv6.

Gets or sets the maximum size for the send queue before payloads are dumped from the queue.

Gets the object for the .

Gets or sets the certificate checker used to validate remote certificates.

The certificate checker will only be used to validate certificates if the is set to null.

Gets or sets the callback used to validate remote certificates.

Gets or sets the callback used to select local certificates.

Gets or sets the path to the certificate used for authentication.

Gets or sets the certificate used to identify this server.

Gets or sets a set of flags which determine the enabled .

Gets or sets a flag that determines whether a client certificate is required during authentication.

Gets or sets a boolean value that determines whether the certificate revocation list is checked during authentication.

Gets or sets the path to the directory containing the trusted certificates.

Gets or sets the set of valid policy errors when validating remote certificates.

Gets or sets the set of valid chain flags used when validating remote certificates.

Represents a socket that has been wrapped in an for encryption.

Gets the connected to the remote host.

Gets the stream through which data is passed when sending to or receiving from the remote host.

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Represents a TCP-based communication client.

The socket can be bound to a specified interface on a machine with multiple interfaces by specifying the IP of the interface in the (Example: "Server=localhost:8888; Interface=192.168.1.15") This example shows how to use the component:


            using System;
            using GSF;
            using GSF.Communication;
            using GSF.Security.Cryptography;
            using GSF.IO.Compression;
            
            class Program
            {
                static TcpClient s_client;
            
                static void Main(string[] args)
                {
                    // Initialize the client.
                    s_client = new TcpClient("Server=localhost:8888");
                    s_client.Handshake = false;
                    s_client.PayloadAware = false;
                    s_client.ReceiveTimeout = -1;
                    s_client.MaxConnectionAttempts = 5;
                    s_client.Encryption = CipherStrength.None;
                    s_client.Compression = CompressionStrength.NoCompression;
                    s_client.SecureSession = false;
                    s_client.Initialize();
                    // Register event handlers.
                    s_client.ConnectionAttempt += s_client_ConnectionAttempt;
                    s_client.ConnectionEstablished += s_client_ConnectionEstablished;
                    s_client.ConnectionTerminated += s_client_ConnectionTerminated;
                    s_client.ReceiveDataComplete += s_client_ReceiveDataComplete;
                    // Connect the client.
                    s_client.Connect();
            
                    // Transmit user input to the server.
                    string input;
                    while (string.Compare(input = Console.ReadLine(), "Exit", true) != 0)
                    {
                        s_client.Send(input);
                    }
            
                    // Disconnect the client on shutdown.
                    s_client.Dispose();
                }
            
                static void s_client_ConnectionAttempt(object sender, EventArgs e)
                {
                    Console.WriteLine("Client is connecting to server.");
                }
            
                static void s_client_ConnectionEstablished(object sender, EventArgs e)
                {
                    Console.WriteLine("Client connected to server.");
                }
            
                static void s_client_ConnectionTerminated(object sender, EventArgs e)
                {
                    Console.WriteLine("Client disconnected from server.");
                }
            
                static void s_client_ReceiveDataComplete(object sender, EventArgs<byte[], int> e)
                {
                    Console.WriteLine(string.Format("Received data - {0}.", s_client.TextEncoding.GetString(e.Argument1, 0, e.Argument2)));
                }
            }

Specifies the default value for the property.

Initializes a new instance of the class.

Connect string of the . See for format.

Initializes a new instance of the class.

object that contains the .

Reads a number of bytes from the current received data buffer and writes those bytes into a byte array at the specified offset.

Saves settings to the config file if the property is set to true.

Loads saved settings from the config file if the property is set to true.

Disconnects the from the connected server synchronously.

Connects the to the server asynchronously.

Attempt is made to connect the when it is not disconnected. for the asynchronous operation.

Releases the unmanaged resources used by the and optionally releases the managed resources.

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Validates the specified .

Connection string to be validated. Server property is missing. Server property is invalid. Server port value is not between and .

Sends data to the server asynchronously.

Raises the event.

Exception to send to event.

Raises the event.

Exception to send to event.

Raises the event.

Exception to send to event.

Callback method for asynchronous connect operation.

Sends a payload on the socket.

Callback method for asynchronous send operation.

Initiate method for asynchronous receive operation of payload data.

Initiate method for asynchronous receive operation of payload data in "payload-aware" mode.

Callback method for asynchronous receive operation of payload data in "payload-aware" mode.

Initiate method for asynchronous receive operation of payload data in "payload-unaware" mode.

Callback method for asynchronous receive operation of payload data in "payload-unaware" mode.

Processes the termination of client.

Gets or sets a boolean value that indicates whether the payload boundaries are to be preserved during transmission.

Gets or sets the byte sequence used to mark the beginning of a payload in a transmission.

The value being assigned is null or empty buffer.

Gets or sets a boolean value that indicates whether the current Windows account credentials are used for authentication.

This option is ignored under Mono deployments.

Gets or sets a boolean value that indicates whether the server should ignore errors when the client's credentials are invalid.

This property should only be set to true if there is an alternative by which to authenticate the client when integrated security fails.

Gets or sets a boolean value that determines if dual-mode socket is allowed when endpoint address is IPv6.

Gets or sets the maximum size for the send queue before payloads are dumped from the queue.

Gets the object for the .

Gets the server URI of the .

Gets the receive handler for receiving data on the socket.

Gets or sets network credential that is used when is set to true.

Gets the descriptive status of the client.

Represents a TCP-based communication server.

The socket can be bound to a specified interface on a machine with multiple interfaces by specifying the interface in the (Example: "Port=8888; Interface=127.0.0.1") This example shows how to use the component:


            using System;
            using GSF;
            using GSF.Communication;
            using GSF.Security.Cryptography;
            using GSF.IO.Compression;
            
            class Program
            {
                static TcpServer m_server;
            
                static void Main(string[] args)
                {
                    // Initialize the server.
                    m_server = new TcpServer("Port=8888");
                    m_server.Handshake = false;
                    m_server.PayloadAware = false;
                    m_server.ReceiveTimeout = -1;
                    m_server.Encryption = CipherStrength.None;
                    m_server.Compression = CompressionStrength.NoCompression;
                    m_server.SecureSession = false;
                    m_server.Initialize();
                    // Register event handlers.
                    m_server.ServerStarted += m_server_ServerStarted;
                    m_server.ServerStopped += m_server_ServerStopped;
                    m_server.ClientConnected += m_server_ClientConnected;
                    m_server.ClientDisconnected += m_server_ClientDisconnected;
                    m_server.ReceiveClientDataComplete += m_server_ReceiveClientDataComplete;
                    // Start the server.
                    m_server.Start();
            
                    // Multicast user input to all connected clients.
                    string input;
                    while (string.Compare(input = Console.ReadLine(), "Exit", true) != 0)
                    {
                        m_server.Multicast(input);
                    }
            
                    // Stop the server on shutdown.
                    m_server.Stop();
                }
            
                static void m_server_ServerStarted(object sender, EventArgs e)
                {
                    Console.WriteLine("Server has been started!");
                }
            
                static void m_server_ServerStopped(object sender, EventArgs e)
                {
                    Console.WriteLine("Server has been stopped!");
                }
            
                static void m_server_ClientConnected(object sender, EventArgs<Guid> e)
                {
                    Console.WriteLine(string.Format("Client connected - {0}.", e.Argument));
                }
            
                static void m_server_ClientDisconnected(object sender, EventArgs<Guid> e)
                {
                    Console.WriteLine(string.Format("Client disconnected - {0}.", e.Argument));
                }
            
                static void m_server_ReceiveClientDataComplete(object sender, EventArgs<Guid, byte[], int> e)
                {
                    Console.WriteLine(string.Format("Received data from {0} - {1}.", e.Argument1, m_server.TextEncoding.GetString(e.Argument2, 0, e.Argument3)));
                }
            }

Specifies the default value for the property.

Initializes a new instance of the class.

Config string of the . See for format.

Initializes a new instance of the class.

object that contains the .

Reads a number of bytes from the current received data buffer and writes those bytes into a byte array at the specified offset.

Saves settings to the config file if the property is set to true.

Loads saved settings from the config file if the property is set to true.

Stops the synchronously and disconnects all connected clients.

Starts the synchronously and begins accepting client connections asynchronously.

Attempt is made to the when it is running.

Disconnects the specified connected client.

ID of the client to be disconnected. Client does not exist for the specified .

Gets the object associated with the specified client ID.

ID of the client. The TCP client. A object.

Gets the object associated with the specified client ID.

ID of the client. The principal of the client. A object.

Validates the specified .

Configuration string to be validated. Port property is missing. Port property value is not between and .

Sends data to the specified client asynchronously.

Raises the event.

ID of client to send to event. Exception to send to event.

Raises the event.

ID of client to send to event. Exception to send to event.

Raises the event.

ID of client to send to event. Exception to send to event.

Callback method for asynchronous accept operation.

Asynchronous loop sends payloads on the socket.

Callback method for asynchronous send operation.

Initiate method for asynchronous receive operation of payload data.

Initiate method for asynchronous receive operation of payload data in "payload-aware" mode.

Callback method for asynchronous receive operation of payload data in "payload-aware" mode.

Initiate method for asynchronous receive operation of payload data in "payload-unaware" mode.

Callback method for asynchronous receive operation of payload data in "payload-unaware" mode.

Processes the termination of client.

Returns the used for receiving data on the socket.

Gets or sets a boolean value that indicates whether the payload boundaries are to be preserved during transmission.

Gets or sets the byte sequence used to mark the beginning of a payload in a transmission.

The value being assigned is null or empty buffer.

Gets or sets a boolean value that indicates whether the client Windows account credentials are used for authentication.

This option is ignored under Mono deployments.

Gets or sets a boolean value that indicates whether the server should ignore errors when the client's credentials are invalid.

Gets or sets a boolean value that determines if dual-mode socket is allowed when endpoint address is IPv6.

Gets or sets the maximum size for the send queue before payloads are dumped from the queue.

Gets the object for the .

Gets the receive handler used to handle data received on the connected sockets.

Gets the descriptive status of the client.

IP stack enumeration.

IPv6 stack.

Requests to use IPv6 stack if possible.

IPv4 stack.

Requests to use IPv4 stack if possible.

Default stack.

Requests to use the default OS IP stack.

Defines helper methods related to IP socket based communications.

Specifies the lowest valid port number for a .

Specifies the highest valid port number for a .

Regular expression used to validate the format for an endpoint.

Matches the following valid input:
- localhost:80
- 127.0.0.1:80
- [::1]:80
- [FEDC:BA98:7654:3210:FEDC:BA98:7654:3210]:80

Creates an for the specified host name and port number.

The host name or IP address to resolve. The port number to be associated with the address. Desired IP stack to use. An object.

Creates a for the specified and .

The local address where the will be bound. The port number at which the will be bound. One of the values. Desired IP stack to use. Determines if dual-mode socket is allowed when endpoint address is IPv6. An object.

Determines if an IP address (or DNS name) is a local IP address.

DNS name or IP address to test. true if is a local IP address; otherwise false. An error is encountered when resolving . is an invalid IP address. The length of is greater than 255 characters. is null.

Gets the default IP stack for this system.

System's assumed default IP stack.

Derives the desired from the "interface" setting in the connection string key/value pairs.

Connection string key/value pairs. Desired based on "interface" setting. The "interface" setting will be added to the if it doesn't exist, in this case return value will be .

Determines if the specified is an IPv6 IP.

IP address to check. true if the is IPv6 IP; otherwise false.

Determines if the specified is a multicast IP.

IP address to check. true if the is multicast IP; otherwise false.

Determines whether the specified port is valid.

The port number to be validated. True if the port number is valid.

Determines if the specified UDP destination is listening for data.

The for the UDP destination to be checked. true if the UDP destination is listening for data; otherwise false.

Indicates the protocol used in server-client communication.

is Transmission Control Protocol.

is User Datagram Protocol.

is serial interface.

is file-system based.

A class for managing the communication between server and client.

of the object used for server-client communication.

ID of the object.

Provider for the transportation of data.

Number of bytes received in .

for the object.

Optional multicast membership addresses used when a multicast source address is specified.

Initializes a new instance of the class.

Establishes (or reestablishes) a send buffer of a given size.

Desired minimum size of send buffer. New send buffer.

Establishes (or reestablishes) a receive buffer of a given size.

Desired minimum size of receive buffer. New receive buffer.

Resets .

Gets buffer used for sending data.

Use to reset and/or establish send buffer size.

Gets send buffer requested size.

Gets buffer used for receiving data.

Use to reset and/or establish receive buffer size.

Gets receive buffer requested size.

A class for statistics related to server-client communication.

of the last send operation. (UTC Time)

of the last receive operation. (UTC Time)

Number of bytes sent in the last send operation.

Number of bytes received in the last receive operation.

Total number of bytes sent.

Total number of bytes received.

Resets the .

Updates statistics related to sending of data.

Number of bytes sent in the send operation.

Updates statistics related to receiving of data.

Number of bytes received in the receive operation.

Represents a UDP-based communication server.

Use when the primary purpose is to receive data. The socket can be bound to a specified interface on a machine with multiple interfaces by specifying the interface in the (Example: "Server=localhost:8888; Port=8989; Interface=127.0.0.1") The socket can be used just for transmitting data without being bound to a local interface by specifying -1 for the port number in the (Example: "Server=localhost:8888; Port=-1") This example shows how to use the component:


            using System;
            using GSF;
            using GSF.Communication;
            using GSF.Security.Cryptography;
            using GSF.IO.Compression;
            
            class Program
            {
                static UdpClient s_client;
            
                static void Main(string[] args)
                {
                    // Initialize the client.
                    s_client = new UdpClient("Server=localhost:8888; Port=8989");
                    s_client.Handshake = false;
                    s_client.ReceiveTimeout = -1;
                    s_client.Encryption = CipherStrength.None;
                    s_client.Compression = CompressionStrength.NoCompression;
                    s_client.SecureSession = false;
                    s_client.Initialize();
                    // Register event handlers.
                    s_client.ConnectionAttempt += s_client_ConnectionAttempt;
                    s_client.ConnectionEstablished += s_client_ConnectionEstablished;
                    s_client.ConnectionTerminated += s_client_ConnectionTerminated;
                    s_client.ReceiveDataComplete += s_client_ReceiveDataComplete;
                    // Connect the client.
                    s_client.Connect();
            
                    // Transmit user input to the server.
                    string input;
                    while (string.Compare(input = Console.ReadLine(), "Exit", true) != 0)
                    {
                        s_client.Send(input);
                    }
            
                    // Disconnect the client on shutdown.
                    s_client.Dispose();
                }
            
                static void s_client_ConnectionAttempt(object sender, EventArgs e)
                {
                    Console.WriteLine("Client is connecting to server.");
                }
            
                static void s_client_ConnectionEstablished(object sender, EventArgs e)
                {
                    Console.WriteLine("Client connected to server.");
                }
            
                static void s_client_ConnectionTerminated(object sender, EventArgs e)
                {
                    Console.WriteLine("Client disconnected from server.");
                }
            
                static void s_client_ReceiveDataComplete(object sender, EventArgs<byte[], int> e)
                {
                    Console.WriteLine(string.Format("Received data - {0}.", s_client.TextEncoding.GetString(e.Argument1, 0, e.Argument2)));
                }
            }

Specifies the default value for the property.

Specifies the constant to be used for disabling when endpoint is not listening.

Initializes a new instance of the class.

Connect string of the . See for format.

Initializes a new instance of the class.

object that contains the .

Reads a number of bytes from the current received data buffer and writes those bytes into a byte array at the specified offset.

Saves settings to the config file if the property is set to true.

Loads saved settings from the config file if the property is set to true.

Disconnects the from the connected server synchronously.

Connects the to the server asynchronously.

Server property in is invalid. Attempt is made to connect the when it is not disconnected. for the asynchronous operation.

Adds a multicast membership to the UDP socket.

Multicast address to join. Address which defines the source of the data or null if the membership is not source-specific.

Drops a multicast membership from the UDP socket.

Multicast address to drop. Address which defines the source of the data or null if the membership is not source-specific.

Releases the unmanaged resources used by the and optionally releases the managed resources.

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Validates the specified .

Connection string to be validated. Port property is missing. Port property value is not between and .

Connects to the .

Sends data to the server asynchronously.

The buffer that contains the binary data to be sent. The zero-based position in the at which to begin sending data. The number of bytes to be sent from starting at the . The end point which identifies the destination for the data. for the asynchronous operation.

Raises the event.

Exception to send to event.

Raises the event.

Exception to send to event.

Raises the event.

Sends a payload on the socket.

Callback method for asynchronous send operation.

Initiate method for asynchronous receive operation of payload data.

Callback method for asynchronous receive operation of payload data.

Processes the termination of client.

Calls all the receive handlers in sequence.

Raises the event.

End-point from which data has been received. Packet information for received data, if available. Number of bytes received from the client.

Raises the event.

End-point from which data has been received. Packet information for received data, if available. Data received from the client. Number of bytes received from the client.

Occurs when unprocessed data has been received from the server.

This event can be used to receive a notification that server data has arrived. The method can then be used to copy data to an existing buffer. In many cases it will be optimal to use an existing buffer instead of subscribing to the event. is the end-point that data has been received from.
is the number of bytes received in the buffer from the server.

Occurs when data received from the server has been processed and is ready for consumption.

is the end-point that data has been received from.
is a new buffer containing post-processed data received from the server starting at index zero.
is the number of post-processed bytes received in the buffer from the server.

Gets or sets a boolean value that determines if dual-mode socket is allowed when endpoint address is IPv6.

Gets or sets the maximum size for the send queue before payloads are dumped from the queue.

Gets the object for the .

Gets the server URI of the .

Gets or sets the size of the buffer used by the client for receiving data from the server.

The value being assigned is either zero or negative.

Gets or sets the maximum expected size for packets being received by this .

Gets or sets the flag that determines whether the UDP client should attempt to receive packet info when receiving data from the socket.

Gets the descriptive status of the client.

Defines modes by which the UDP server will identify its clients when receiving messages.

Identify clients by their IP address.

Identify clients by the port they are bound to.

Identify clients by both their IP address and the port they are bound to.

Represents a UDP-based communication server.

Use when the primary purpose is to transmit data. The socket can be bound to a specified interface on a machine with multiple interfaces by specifying the interface in the (Example: "Port=8888; Clients=localhost:8989; Interface=127.0.0.1") The socket can be used just for transmitting data without being bound to a local interface by specifying -1 for the port number in the (Example: "Port=-1; Clients=localhost:8989") This example shows how to use the component:


            using System;
            using GSF;
            using GSF.Communication;
            using GSF.Security.Cryptography;
            using GSF.IO.Compression;
            
            class Program
            {
                static UdpServer m_server;
            
                static void Main(string[] args)
                {
                    // Initialize the server.
                    m_server = new UdpServer("Port=8888; Clients=localhost:8989");
                    m_server.Handshake = false;
                    m_server.ReceiveTimeout = -1;
                    m_server.Encryption = CipherStrength.None;
                    m_server.Compression = CompressionStrength.NoCompression;
                    m_server.SecureSession = false;
                    m_server.Initialize();
                    // Register event handlers.
                    m_server.ServerStarted += m_server_ServerStarted;
                    m_server.ServerStopped += m_server_ServerStopped;
                    m_server.ClientConnected += m_server_ClientConnected;
                    m_server.ClientDisconnected += m_server_ClientDisconnected;
                    m_server.ReceiveClientDataComplete += m_server_ReceiveClientDataComplete;
                    // Start the server.
                    m_server.Start();
            
                    // Multicast user input to all connected clients.
                    string input;
                    while (string.Compare(input = Console.ReadLine(), "Exit", true) != 0)
                    {
                        m_server.Multicast(input);
                    }
            
                    // Stop the server on shutdown.
                    m_server.Stop();
                }
            
                static void m_server_ServerStarted(object sender, EventArgs e)
                {
                    Console.WriteLine("Server has been started!");
                }
            
                static void m_server_ServerStopped(object sender, EventArgs e)
                {
                    Console.WriteLine("Server has been stopped!");
                }
            
                static void m_server_ClientConnected(object sender, EventArgs<Guid> e)
                {
                    Console.WriteLine(string.Format("Client connected - {0}.", e.Argument));
                }
            
                static void m_server_ClientDisconnected(object sender, EventArgs<Guid> e)
                {
                    Console.WriteLine(string.Format("Client disconnected - {0}.", e.Argument));
                }
            
                static void m_server_ReceiveClientDataComplete(object sender, EventArgs<Guid, byte[], int> e)
                {
                    Console.WriteLine(string.Format("Received data from {0} - {1}.", e.Argument1, m_server.TextEncoding.GetString(e.Argument2, 0, e.Argument3)));
                }
            }

Specifies the default value for the property.

Specifies the constant to be used for disabling when endpoint is not listening.

Initializes a new instance of the class.

Configuration string of the . See for format.

Initializes a new instance of the class.

object that contains the .

Reads a number of bytes from the current received data buffer and writes those bytes into a byte array at the specified offset.

Saves settings to the config file if the property is set to true.

Loads saved settings from the config file if the property is set to true.

Stops the synchronously and disconnects all connected clients.

Starts the synchronously and begins accepting client connections asynchronously.

Attempt is made to the when it is running.

Disconnects the specified connected client.

ID of the client to be disconnected. Client does not exist for the specified .

Gets the object associated with the specified client ID.

ID of the client. The UDP client. An object. Client does not exist for the specified .

Validates the specified .

Configuration string to be validated. Port property is missing. Port property value is not between and .

Sends data to the specified client asynchronously.

Raises the event.

ID of client to send to event. Exception to send to event.

Raises the event.

ID of client to send to event. Exception to send to event.

Loops waiting for payloads and sends them on the socket.

Callback method for asynchronous send operation.

Initiate method for asynchronous receive operation of payload data from any endpoint.

Callback method for asynchronous receive operation of payload data from any endpoint.

Gets or sets the mode by which the UDP server will identify its clients when receiving messages.

Gets or sets a boolean value that determines if dual-mode socket is allowed when endpoint address is IPv6.

Gets or sets a boolean value that determines if UDP server should always send responses to clients on the port that data is received from the client.

Gets or sets the maximum size for the send queue before payloads are dumped from the queue.

Gets the object for the .

Gets the descriptive status of the client.