RUDPServer Component

Properties   Methods   Events   Configuration Settings   Errors  

The RUDPServer component is a Reliable UDP server based on an asynchronous, event-driven architecture. It is designed to balance the load between connections for a fast, powerful server.

Syntax

nsoftware.IPWorksP2P.Rudpserver

Remarks

The RUDPServer component implements a Reliable UDP server based on RFC 908. Use of RUDPServer guarantees that data is delivered to the remote host using UDP as a transport mechanism.

RUDPServer is the server complement of RUDPClient (which is used to create client applications). They share a common design philosophy and interface. We expect you will find RUDPServer as easy to use as RUDPClient.

The connections are identified by a ConnectionId, an id generated by the component to identify each connection. This id is unique to each connection. RUDPServer's events also have ConnectionId as a parameter to identify the connection to which they relate.

Our main goal in designing RUDPServer was to make it easy to use without sacrificing performance. The component has a minimum of properties, and events.

RUDPServer can start to listen on a port by setting the Listening property to True. When a remote host asks for a connection, the ConnectionRequest event is fired. At that point, the connection can either be accepted or rejected. If the connection is accepted, a ConnectionId is assigned, and communication can start. From this point on, the operation is very similar to RUDPClient. Data is sent by assigning the data string to the DataToSend field. The address and port of the incoming connection can be found by querying the RemoteHost and RemotePort fields.

Rudpserver server = new Rudpserver();
server.OnDataIn += (s,e) => {
  //The DataIn event fires when data is received.
  Console.WriteLine("Server Received: " + e.Text);
  //Echo text back
  server.Connections[e.ConnectionId].DataToSend = e.Text;
};

server.LocalPort = 4444;
server.Listening = true;

Rudpclient client = new Rudpclient();
client.OnDataIn += (s, e) => {
  //The DataIn event fires when data is received.
  Console.WriteLine("Client Received: " + e.Text);
};

client.Connect("localhost", 4444);

//Send data to the server
client.DataToSend = "Hello World!";

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

ConnectionBacklogThe maximum number of pending connections.
ConnectionsA collection of currently connected clients.
DefaultTimeoutAn initial timeout value to be used by incoming connections.
EncryptingAlgorithmThen encryption algorithm used when encrypting.
EncryptionPasswordThen password to encrypt the connection.
KeepAliveWhen True, KeepAlive packets are enabled (for long connections).
LingerWhen set to True, connections are terminated gracefully.
ListeningIf True, the component accepts incoming connections on LocalPort.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe UDP port in the local host where the component listens.
SSLAuthenticateClientsIf true, the server asks the client(s) for a certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLEnabledWhether TLS/SSL is enabled.
TURNOAuthAccessTokenTBD.(The oauth access token in hex format).
TURNOAuthSessionKeyTBD.(The oauth Session Key: mac_key in hex format).
TURNPasswordTBD.
TURNPortTBD.
TURNRelayedIPTBD.
TURNRelayedPortTBD.
TURNServerTBD.
TURNUserTBD.

Method List


The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

AddTURNClientAdds a peer client.
ConfigSets or retrieves a configuration setting.
DisconnectDisconnect the specified client.
DoEventsProcesses events from the internal message queue.
InterruptInterrupts a synchronous send to the remote host.
SendSends data to the remote host.
SendFileSend file to the remote host.
SendKeepAliveSends a keep alive packet to the specified client.
ShutdownShuts down the server.

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

ConnectedFired immediately after a connection completes (or fails).
ConnectionRequestFired when a request for connection comes from a remote host.
DataInFired when data comes in.
DisconnectedFired when a connection is closed.
ErrorInformation about errors during data delivery.
ReadyToSendFired when the component is ready to send data.
SSLClientAuthenticationFired when the client presents its credentials to the server.
SSLConnectionRequestTBD. (It only be valid when UseInternalSecurityAPI=true).
SSLStatusShows the progress of the secure connection.
StatusFires with information about the operation.

Configuration Settings


The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.

CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
DefaultMaxIncomingOutstandingCountThe maximum number of outstanding segments.
DefaultMaxIncomingSegmentSizeThe maximum segment size in bytes.
DefaultSequencedDeliveryWhether the connection uses sequenced delivery.
KeepAliveIntervalThe retry interval, in seconds, to be used when a keep-alive packet is sent and no response is received.
KeepAliveRetryCountThe number of times to retry sending the keep-alive packet when there is no response.
KeepAliveTimeThe inactivity time in seconds before a keep-alive packet is sent.
LogOptionsThe level of messages to log.
MaxIncomingOutstandingCountThe maximum number of outstanding segments.
MaxIncomingSegmentSizeThe maximum segment size in bytes.
MaxOutgoingOutstandingCount[index]The maximum number of outstanding segments when sending to other party.
MaxOutgoingSegmentSize[index]The maximum segment size of the other party in bytes.
MaxRetransmitCountThe maximum number of retransmission attempts.
RetransmitTimeoutThe timeout in milliseconds between retransmit attempts.
SequencedDeliveryWhether the connection uses sequenced delivery.
UseWorkerThreadWhether to use a background thread to process outstanding operations.
CaptureIPPacketInfoUsed to capture the packet information.
DestinationAddressUsed to get the destination address from the packet information.
DontFragmentUsed to set the Don't Fragment flag of outgoing packets.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxPacketSizeThe maximum length of the packets that can be received.
QOSDSCPValueUsed to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficTypeUsed to specify QOS/DSCP settings (optional).
ShareLocalPortIf set to True, allows more than one instance of the component to be active on the same local port.
UseConnectionDetermines whether to use a connected socket.
UseIPv6Whether or not to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks P2P 2020 .NET Edition - Version 20.0 [Build 8235]