PipeServer Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

nsoftware.IPWorksIPC.Pipeserver

Remarks

PipeServer is the server complement of PipeClient (which is used to create client applications). They share a common design philosophy and interface. PipeServer is as easy to use as PipeClient.

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

Our main goal in designing PipeServer was to make it easy to use without sacrificing performance. The component has a minimum of properties, and events: Connected, DataIn, Disconnected, ReadyToSend, and Error.

PipeServer can start to listen on a pipe by setting PipeName and then setting Listening to True. When a client connects the Connected event fires, a ConnectionId is assigned, and communication can start. From this point on, the operation is very similar to PipeClient. Data is sent by assigning the data string to the DataToSend field.

Property List

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

Method List

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

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.

Config Settings

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

Connections Property (PipeServer Component)

A collection of currently connected clients.

Syntax

• C#
• VB.NET

public PipeConnectionMap Connections { get; }

Public ReadOnly Property Connections As PipeConnectionMap

Remarks

This property contains a collection of currently connected clients. All of the connections may be managed using this property. Each connection is described by the different fields of the PipeConnection type.

This collection is a hashtable type of collection, in which the Connection Id string is used as the key to the desired connection. The Connected event fires when a client connects and provides the Connection Id (key) that identifies the client.

Example (Broadcasting Data) foreach (Connection c in pipeserver1.Connections.Values) { c.DataToSend = "Broadcast Data"; }

This property is read-only.

DefaultEOL Property (PipeServer Component)

This property includes a default end-of-line (EOL) value to be used by incoming connections.

Syntax

• C#
• VB.NET

public string DefaultEOL { get; set; }
public byte[] DefaultEOLB { get; set; }

Public Property DefaultEOL As String
Public Property DefaultEOLB As Byte()

Default Value

""

Remarks

This property contains a default end-of-line (EOL) value to be used by incoming connections. Once the component accepts and establishes an inbound connection, it will set that connection's EOL to the value in this property. By default, this value is empty (""), meaning that data will be fired as it is received.

DefaultMaxLineLength Property (PipeServer Component)

The property includes the default maximum line length value for inbound connections.

Syntax

• C#
• VB.NET

public int DefaultMaxLineLength { get; set; }

Public Property DefaultMaxLineLength As Integer

Default Value

2048

Remarks

This property controls the default size of an internal buffer that holds received data while waiting for an end-of-line (EOL) string.

The minimum value for this property is 256 bytes. The default value is 2048 bytes.

DefaultSingleLineMode Property (PipeServer Component)

This property tells the component whether or not to treat new connections as line oriented.

Syntax

• C#
• VB.NET

public bool DefaultSingleLineMode { get; set; }

Public Property DefaultSingleLineMode As Boolean

Default Value

False

Remarks

This property instructs the component whether or not to treat newly established connections as line-oriented protocols. If this value is True, newly accepted connections will read the incoming data stream as lines separated by a carriage return line feed (CRLF), carriage return (CR), or line feed (LF) and will ignore the end of lines (EOLs).

DefaultTimeout Property (PipeServer Component)

This property includes an initial timeout value to be used by incoming connections.

Syntax

• C#
• VB.NET

public int DefaultTimeout { get; set; }

Public Property DefaultTimeout As Integer

Default Value

0

Remarks

This property is used by the component to set the operational timeout value of all inbound connections once they are established.

This property defines the timeout when sending data. When SSLEnabled is False, a value of 0 means data will be sent asynchronously, and a positive value means data is sent synchronously.

When SSLEnabled is True, all data are sent synchronously regardless of the Timeout value.

Listening Property (PipeServer Component)

If True, the component accepts incoming connections.

Syntax

• C#
• VB.NET

public bool Listening { get; set; }

Public Property Listening As Boolean

Default Value

False

Remarks

Use this property to make the component 'listen' (accept connections) on the pipe specified by PipeName. Setting this property to False will make the component stop listening. Please note that this does not close any existing connections.

Note: Use the StartListening and StopListening methods to control whether the component is listening.

This property is not available at design time.

PipeName Property (PipeServer Component)

The name of the pipe.

Syntax

• C#
• VB.NET

public string PipeName { get; set; }

Public Property PipeName As String

Default Value

""

Remarks

This property specifies the name of the pipe on which to accept connections. Clients must use this name when establishing a connection to PipeServer.

Config Method (PipeServer Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Disconnect Method (PipeServer Component)

This method disconnects the specified client.

Syntax

• C#
• VB.NET

public void Disconnect(string connectionId);

Async Version
public async Task Disconnect(string connectionId);
public async Task Disconnect(string connectionId, CancellationToken cancellationToken);

Public Sub Disconnect(ByVal ConnectionId As String)

Async Version
Public Sub Disconnect(ByVal ConnectionId As String) As Task
Public Sub Disconnect(ByVal ConnectionId As String, cancellationToken As CancellationToken) As Task

Remarks

Calling this method will disconnect the client specified by the ConnectionId parameter.

DoEvents Method (PipeServer Component)

Processes events from the internal message queue.

Syntax

• C#
• VB.NET

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);

Public Sub DoEvents()

Async Version
Public Sub DoEvents() As Task
Public Sub DoEvents(cancellationToken As CancellationToken) As Task

Remarks

When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Interrupt Method (PipeServer Component)

This method interrupts a synchronous send to the remote host.

Syntax

• C#
• VB.NET

public void Interrupt(string connectionId);

Async Version
public async Task Interrupt(string connectionId);
public async Task Interrupt(string connectionId, CancellationToken cancellationToken);

Public Sub Interrupt(ByVal ConnectionId As String)

Async Version
Public Sub Interrupt(ByVal ConnectionId As String) As Task
Public Sub Interrupt(ByVal ConnectionId As String, cancellationToken As CancellationToken) As Task

Remarks

This property is called using the Connection Id if you wish to interrupt a connection and stop a file from uploading without disconnecting the client connected to the component. If you use SendFile to upload a file, the component will run synchronously on that Connection Id until it is completed.

Send Method (PipeServer Component)

This method sends binary data to the specified client.

Syntax

• C#
• VB.NET

public void Send(string connectionId, byte[] text);

Async Version
public async Task Send(string connectionId, byte[] text);
public async Task Send(string connectionId, byte[] text, CancellationToken cancellationToken);

Public Sub Send(ByVal ConnectionId As String, ByVal Text As String)

Async Version
Public Sub Send(ByVal ConnectionId As String, ByVal Text As String) As Task
Public Sub Send(ByVal ConnectionId As String, ByVal Text As String, cancellationToken As CancellationToken) As Task

Remarks

This method sends binary data to the client identified by ConnectionId. To send text, use the SendText method instead.

When Timeout is set to 0 and SSLEnabled is set to False, the component will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with exception 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

Note: The ReadyToSend event is not fired when part of the data is sent successfully.

When SSLEnabled is True or Timeout is set to a positive value, the component behaves synchronously.

SendFile Method (PipeServer Component)

This method sends the file to the remote host.

Syntax

• C#
• VB.NET

public void SendFile(string connectionId, string fileName);

Async Version
public async Task SendFile(string connectionId, string fileName);
public async Task SendFile(string connectionId, string fileName, CancellationToken cancellationToken);

Public Sub SendFile(ByVal ConnectionId As String, ByVal FileName As String)

Async Version
Public Sub SendFile(ByVal ConnectionId As String, ByVal FileName As String) As Task
Public Sub SendFile(ByVal ConnectionId As String, ByVal FileName As String, cancellationToken As CancellationToken) As Task

Remarks

This method sends the file to the client specified by the ConnectionId.

Note: This method operate synchronously. DefaultTimeout or Timeout must be set to a positive value before calling this method.

SendLine Method (PipeServer Component)

This method sends a string followed by a new line.

Syntax

• C#
• VB.NET

public void SendLine(string connectionId, string text);

Async Version
public async Task SendLine(string connectionId, string text);
public async Task SendLine(string connectionId, string text, CancellationToken cancellationToken);

Public Sub SendLine(ByVal ConnectionId As String, ByVal Text As String)

Async Version
Public Sub SendLine(ByVal ConnectionId As String, ByVal Text As String) As Task
Public Sub SendLine(ByVal ConnectionId As String, ByVal Text As String, cancellationToken As CancellationToken) As Task

Remarks

This method is used to send data with line-oriented protocols. The line is followed by CRLF ("\r\n") .

Please refer to the GetLine method and SingleLineMode property for more information.

Shutdown Method (PipeServer Component)

This method shuts down the server.

Syntax

• C#
• VB.NET

public void Shutdown();

Async Version
public async Task Shutdown();
public async Task Shutdown(CancellationToken cancellationToken);

Public Sub Shutdown()

Async Version
Public Sub Shutdown() As Task
Public Sub Shutdown(cancellationToken As CancellationToken) As Task

Remarks

This method shuts down the server. Calling this method is equivalent to calling StopListening and then breaking every client connection by calling Disconnect.

StartListening Method (PipeServer Component)

This method starts listening for incoming connections.

Syntax

• C#
• VB.NET

public void StartListening();

Async Version
public async Task StartListening();
public async Task StartListening(CancellationToken cancellationToken);

Public Sub StartListening()

Async Version
Public Sub StartListening() As Task
Public Sub StartListening(cancellationToken As CancellationToken) As Task

Remarks

This method begins listening for incoming connections on the pipe specified by PipeName.

To stop listening for new connections, call StopListening. To stop listening for new connections and to disconnect all existing clients, call Shutdown.

StopListening Method (PipeServer Component)

This method stops listening for new connections.

Syntax

• C#
• VB.NET

public void StopListening();

Async Version
public async Task StopListening();
public async Task StopListening(CancellationToken cancellationToken);

Public Sub StopListening()

Async Version
Public Sub StopListening() As Task
Public Sub StopListening(cancellationToken As CancellationToken) As Task

Remarks

This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.

To stop listening and to disconnect all existing clients, call Shutdown instead.

Connected Event (PipeServer Component)

Fired immediately after a connection completes.

Syntax

• C#
• VB.NET

public event OnConnectedHandler OnConnected;

public delegate void OnConnectedHandler(object sender, PipeserverConnectedEventArgs e);

public class PipeserverConnectedEventArgs : EventArgs {
  public string ConnectionId { get; }
}

Public Event OnConnected As OnConnectedHandler

Public Delegate Sub OnConnectedHandler(sender As Object, e As PipeserverConnectedEventArgs)

Public Class PipeserverConnectedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
End Class

Remarks

This event fires immediately after a client connects. The ConnectionId parameter identifies the client connection.

DataIn Event (PipeServer Component)

This event is fired when data come in.

Syntax

• C#
• VB.NET

public event OnDataInHandler OnDataIn;

public delegate void OnDataInHandler(object sender, PipeserverDataInEventArgs e);

public class PipeserverDataInEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string Text { get; }
  public byte[] TextB { get; }
  public bool EOL { get; }
}

Public Event OnDataIn As OnDataInHandler

Public Delegate Sub OnDataInHandler(sender As Object, e As PipeserverDataInEventArgs)

Public Class PipeserverDataInEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property Text As String
  Public ReadOnly Property TextB As Byte()
  Public ReadOnly Property EOL As Boolean
End Class

Remarks

Trapping the DataIn event is your only chance to get the data coming from the other end of the connection specified by ConnectionId. The incoming data are provided through the Text parameter.

EOL indicates whether or not the EOL string was found at the end of Text. If the EOL string was found, then EOL is True.

If Text is part of the data portion of length larger than either DefaultMaxLineLength or MaxLineLength with no EOL strings in it, then EOL is False. Please note that this means that one or more DataIn events with EOL set to False can be received during a connection.

If the EOL property is "" (empty string), then EOL can be disregarded (it is always True).

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Disconnected Event (PipeServer Component)

Fires when a client disconnects.

Syntax

• C#
• VB.NET

public event OnDisconnectedHandler OnDisconnected;

public delegate void OnDisconnectedHandler(object sender, PipeserverDisconnectedEventArgs e);

public class PipeserverDisconnectedEventArgs : EventArgs {
  public string ConnectionId { get; }
}

Public Event OnDisconnected As OnDisconnectedHandler

Public Delegate Sub OnDisconnectedHandler(sender As Object, e As PipeserverDisconnectedEventArgs)

Public Class PipeserverDisconnectedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
End Class

Remarks

This event fires when a client disconnects. The ConnectionId parameters identifies the client that is disconnected.

Error Event (PipeServer Component)

This event fires information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, PipeserverErrorEventArgs e);

public class PipeserverErrorEventArgs : EventArgs {
  public string ConnectionId { get; }
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As PipeserverErrorEventArgs)

Public Class PipeserverErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally, the component throws an exception.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

ConnectionId indicates the connection for which the error is applicable.

ReadyToSend Event (PipeServer Component)

Fired when the component is ready to send data.

Syntax

• C#
• VB.NET

public event OnReadyToSendHandler OnReadyToSend;

public delegate void OnReadyToSendHandler(object sender, PipeserverReadyToSendEventArgs e);

public class PipeserverReadyToSendEventArgs : EventArgs {
  public string ConnectionId { get; }
}

Public Event OnReadyToSend As OnReadyToSendHandler

Public Delegate Sub OnReadyToSendHandler(sender As Object, e As PipeserverReadyToSendEventArgs)

Public Class PipeserverReadyToSendEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
End Class

Remarks

The ReadyToSend event indicates that the underlying pipe is ready to accept data after a failed DataToSend. The event is also fired immediately after a connection to the remote host is established.

PipeConnection Type

A currently connected client.

Remarks

This type describes the connection of a client which is currently connected to the component. The connection may be managed using the different fields of this type.

Fields

Constructors

• C#
• VB.NET

public PipeConnection();

Public PipeConnection()

Config Settings (PipeServer Component)

PipeServer Config Settings

Base Config Settings

Trappable Errors (PipeServer Component)

PipeServer Errors