# PipeServer Component

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

```text
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](#connected-event-pipeserver-component), [DataIn](#datain-event-pipeserver-component), [Disconnected](#disconnected-event-pipeserver-component), [ReadyToSend](#readytosend-event-pipeserver-component), and [Error](#error-event-pipeserver-component).

PipeServer can start to listen on a pipe by setting [PipeName](#pipename-property-pipeserver-component) and then setting [Listening](#listening-property-pipeserver-component) to True. When a client connects the [Connected](#connected-event-pipeserver-component) event fires, a *ConnectionId* is assigned, and communication can start. From this point on, the operation is very similar to PipeClient.

## Property List

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

|  |  |
| --- | --- |
| [Connections](#connections-property-pipeserver-component) | A collection of currently connected clients. |
| [DefaultEOL](#defaulteol-property-pipeserver-component) | This property includes a default end-of-line (EOL) value to be used by incoming connections. |
| [DefaultMaxLineLength](#defaultmaxlinelength-property-pipeserver-component) | The property includes the default maximum line length value for inbound connections. |
| [DefaultSingleLineMode](#defaultsinglelinemode-property-pipeserver-component) | This property tells the component whether or not to treat new connections as line oriented. |
| [DefaultTimeout](#defaulttimeout-property-pipeserver-component) | This property includes an initial timeout value to be used by incoming connections. |
| [Listening](#listening-property-pipeserver-component) | If True, the component accepts incoming connections. |
| [PipeName](#pipename-property-pipeserver-component) | The name of the pipe. |

## Method List

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

|  |  |
| --- | --- |
| [Config](#config-method-pipeserver-component) | Sets or retrieves a configuration setting. |
| [Disconnect](#disconnect-method-pipeserver-component) | This method disconnects the specified client. |
| [DoEvents](#doevents-method-pipeserver-component) | This method processes events from the internal message queue. |
| [Interrupt](#interrupt-method-pipeserver-component) | This method interrupts a synchronous send to the remote host. |
| [Send](#send-method-pipeserver-component) | This method sends binary data to the specified client. |
| [SendBytes](#sendbytes-method-pipeserver-component) | This method sends binary data to the specified client. |
| [SendFile](#sendfile-method-pipeserver-component) | This method sends the file to the remote host. |
| [SendLine](#sendline-method-pipeserver-component) | This method sends a string followed by a new line. |
| [SendText](#sendtext-method-pipeserver-component) | This method sends text to the specified client. |
| [SetUploadStream](#setuploadstream-method-pipeserver-component) | This method uploads the data in the specified stream. |
| [Shutdown](#shutdown-method-pipeserver-component) | This method shuts down the server. |
| [StartListening](#startlistening-method-pipeserver-component) | This method starts listening for incoming connections. |
| [StopListening](#stoplistening-method-pipeserver-component) | This method stops listening for new connections. |

## 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.*

|  |  |
| --- | --- |
| [Connected](#connected-event-pipeserver-component) | Fired immediately after a connection completes. |
| [DataIn](#datain-event-pipeserver-component) | This event is fired when data come in. |
| [Disconnected](#disconnected-event-pipeserver-component) | Fires when a client disconnects. |
| [Error](#error-event-pipeserver-component) | This event fires information about errors during data delivery. |
| [ReadyToSend](#readytosend-event-pipeserver-component) | Fired when the component is ready to send data. |

## Config Settings

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

|  |  |
| --- | --- |
| [CloseStreamAfterTransfer](#CloseStreamAfterTransfer) | If true, the component will close the upload or download stream after the transfer. |
| [CustomSecurityDescription](#CustomSecurityDescription) | A custom security descriptor to define access to the pipe. |
| [InBufferSize](#InBufferSize) | The size in bytes of the output buffer. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the input buffer. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the component whether or not to use FIPS certified APIs. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# Connections Property ([PipeServer](#pipeserver-component) Component)

A collection of currently connected clients.

## Syntax

```text
public PipeConnectionMap Connections { get; }
```

## 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](#pipeconnection-type) 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](#connected-event-pipeserver-component) event fires when a client connects and provides the Connection Id (key) that identifies the client.

**Example (Broadcasting Data)**

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

This property is read-only.

 Please refer to the [PipeConnection](#pipeconnection-type) type for a complete list of fields.

# DefaultEOL Property ([PipeServer](#pipeserver-component) Component)

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

## Syntax

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

## 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](#pipeserver-component) Component)

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

## Syntax

```text
public int DefaultMaxLineLength { get; set; }
```

## 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](#pipeserver-component) Component)

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

## Syntax

```text
public bool DefaultSingleLineMode { get; set; }
```

## 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](#pipeserver-component) Component)

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

## Syntax

```text
public int DefaultTimeout { get; set; }
```

## 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](#pipeserver-component) Component)

If True, the component accepts incoming connections.

## Syntax

```text
public bool Listening { get; }
```

## Default Value

False

## Remarks

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

Use the [StartListening](#startlistening-method-pipeserver-component) and [StopListening](#stoplistening-method-pipeserver-component) methods to control whether the component is listening.

This property is read-only and not available at design time.

# PipeName Property ([PipeServer](#pipeserver-component) Component)

The name of the pipe.

## Syntax

```text
public string PipeName { get; set; }
```

## 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](#pipeserver-component) Component)

Sets or retrieves a configuration setting.

## Syntax

```text
public string Config(string configurationString);

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

## Remarks

Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-pipeserver-component) 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](#config-settings-pipeserver-component), you must call *Config("PROPERTY")*. The value will be returned as a string.

# Disconnect Method ([PipeServer](#pipeserver-component) Component)

This method disconnects the specified client.

## Syntax

```text
public void Disconnect(string connectionId);

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

## Remarks

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

# DoEvents Method ([PipeServer](#pipeserver-component) Component)

This method processes events from the internal message queue.

## Syntax

```text
public void DoEvents();

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

## 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](#pipeserver-component) Component)

This method interrupts a synchronous send to the remote host.

## Syntax

```text
public void Interrupt(string connectionId);

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

## 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](#sendfile-method-pipeserver-component) to upload a file, the component will run synchronously on that Connection Id until it is completed.

# Send Method ([PipeServer](#pipeserver-component) Component)

This method sends binary data to the specified client.

## Syntax

```text
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);
```

## Remarks

This method sends binary data to the client identified by *ConnectionId*. To send text, use the [SendText](#sendtext-method-pipeserver-component) method instead.

When [Timeout](#PipeConnection_f_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](#readytosend-event-pipeserver-component) event before attempting to send data again.

NOTE: The [ReadyToSend](#readytosend-event-pipeserver-component) event is not fired when part of the data is sent successfully.

When SSLEnabled is True or [Timeout](#PipeConnection_f_Timeout) is set to a positive value, the component behaves synchronously.

# SendBytes Method ([PipeServer](#pipeserver-component) Component)

This method sends binary data to the specified client.

## Syntax

```text
public void SendBytes(string connectionId, byte[] data);

Async Version
public async Task SendBytes(string connectionId, byte[] data);
public async Task SendBytes(string connectionId, byte[] data, CancellationToken cancellationToken);
```

## Remarks

This method sends binary data to the client identified by *ConnectionId*. To send text, use the [SendText](#sendtext-method-pipeserver-component) method instead.

When [Timeout](#PipeConnection_f_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](#readytosend-event-pipeserver-component) event before attempting to send data again.

NOTE: The [ReadyToSend](#readytosend-event-pipeserver-component) event is not fired when part of the data is sent successfully.

When SSLEnabled is True or [Timeout](#PipeConnection_f_Timeout) is set to a positive value, the component behaves synchronously.

# SendFile Method ([PipeServer](#pipeserver-component) Component)

This method sends the file to the remote host.

## Syntax

```text
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);
```

## Remarks

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

Note: This method operate synchronously. [DefaultTimeout](#defaulttimeout-property-pipeserver-component) or [Timeout](#PipeConnection_f_Timeout) must be set to a positive value before calling this method.

# SendLine Method ([PipeServer](#pipeserver-component) Component)

This method sends a string followed by a new line.

## Syntax

```text
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);
```

## 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.

# SendText Method ([PipeServer](#pipeserver-component) Component)

This method sends text to the specified client.

## Syntax

```text
public void SendText(string connectionId, string text);

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

## Remarks

This method sends text to the client identified by *ConnectionId*. To send binary data, use the [SendBytes](#sendbytes-method-pipeserver-component) method instead.

When [Timeout](#PipeConnection_f_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](#readytosend-event-pipeserver-component) event before attempting to send data again.

NOTE: The [ReadyToSend](#readytosend-event-pipeserver-component) event is not fired when part of the data is sent successfully.

When SSLEnabled is True or [Timeout](#PipeConnection_f_Timeout) is set to a positive value, the component behaves synchronously.

# SetUploadStream Method ([PipeServer](#pipeserver-component) Component)

This method uploads the data in the specified stream.

## Syntax

```text
public void SetUploadStream(string connectionId, System.IO.Stream stream);

Async Version
public async Task SetUploadStream(string connectionId, System.IO.Stream stream);
public async Task SetUploadStream(string connectionId, System.IO.Stream stream, CancellationToken cancellationToken);
```

## Remarks

This method uploads the data in the specified stream to the connection identified by *ConnectionId*. The component will automatically close this stream if [CloseStreamAfterTransfer](#CloseStreamAfterTransfer) is *true* (default).

# Shutdown Method ([PipeServer](#pipeserver-component) Component)

This method shuts down the server.

## Syntax

```text
public void Shutdown();

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

## Remarks

This method shuts down the server. Calling this method is equivalent to calling [StopListening](#stoplistening-method-pipeserver-component) and then breaking every client connection by calling [Disconnect](#disconnect-method-pipeserver-component).

# StartListening Method ([PipeServer](#pipeserver-component) Component)

This method starts listening for incoming connections.

## Syntax

```text
public void StartListening();

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

## Remarks

This method begins listening for incoming connections on the pipe specified by [PipeName](#pipename-property-pipeserver-component).

To stop listening for new connections, call [StopListening](#stoplistening-method-pipeserver-component). To stop listening for new connections and to disconnect all existing clients, call [Shutdown](#shutdown-method-pipeserver-component).

# StopListening Method ([PipeServer](#pipeserver-component) Component)

This method stops listening for new connections.

## Syntax

```text
public void StopListening();

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

## 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](#shutdown-method-pipeserver-component) instead.

# Connected Event ([PipeServer](#pipeserver-component) Component)

Fired immediately after a connection completes.

## Syntax

```text
public event OnConnectedHandler OnConnected;

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

public class PipeServerConnectedEventArgs : EventArgs {
  public string ConnectionId { get; }
}
```

## Remarks

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

# DataIn Event ([PipeServer](#pipeserver-component) Component)

This event is fired when data come in.

## Syntax

```text
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; }
}
```

## 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](#defaultmaxlinelength-property-pipeserver-component) or [MaxLineLength](#Connection_f_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](#pipeserver-component) Component)

Fires when a client disconnects.

## Syntax

```text
public event OnDisconnectedHandler OnDisconnected;

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

public class PipeServerDisconnectedEventArgs : EventArgs {
  public string ConnectionId { get; }
}
```

## Remarks

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

# Error Event ([PipeServer](#pipeserver-component) Component)

This event fires information about errors during data delivery.

## Syntax

```text
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; }
}
```

## 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](#trappable-errors-pipeserver-component) section.

*ConnectionId* indicates the connection for which the error is applicable.

# ReadyToSend Event ([PipeServer](#pipeserver-component) Component)

Fired when the component is ready to send data.

## Syntax

```text
public event OnReadyToSendHandler OnReadyToSend;

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

public class PipeServerReadyToSendEventArgs : EventArgs {
  public string ConnectionId { get; }
}
```

## Remarks

The ReadyToSend event indicates that the underlying pipe is ready to accept data after a failed [SendBytes](#sendbytes-method-pipeserver-component). 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.

The following fields are available:

- [AcceptData](#PipeConnection_f_AcceptData)

- [BytesSent](#PipeConnection_f_BytesSent)

- [Connected](#PipeConnection_f_Connected)

- [ConnectionId](#PipeConnection_f_ConnectionId)

- [EOL](#PipeConnection_f_EOL)

- [MaxLineLength](#PipeConnection_f_MaxLineLength)

- [SingleLineMode](#PipeConnection_f_SingleLineMode)

- [Timeout](#PipeConnection_f_Timeout)

## Fields

 **AcceptData** *bool (read-only)*
Default: True

This field indicates whether data reception is currently enabled. When *false*, data reception is disabled and the DataIn event will not fire for the connection. Use the PauseData and ProcessData methods to pause and resume data reception.

 **BytesSent** *int (read-only)*
Default: 0

This field shows how many bytes were sent after calling Send or SendBytes. Please see Send or SendBytes for more information.

NOTE: This field will always return 0 when the component is operating in the synchronous mode (i.e., the [Timeout](#PipeConnection_f_Timeout) property is set to a positive value).

 **Connected** *bool (read-only)*
Default: False

This field is used to disconnect individual connections and/or show their status.

The [Connected](#PipeConnection_f_Connected) field may be set to false to close the connection.

[Connected](#PipeConnection_f_Connected) also shows the status of a particular connection (connected/disconnected).

Use the Connect and Disconnect methods to manage the connection.

 **ConnectionId** *string (read-only)*
Default: ""

This field contains an identifier generated by the component to identify each connection. This identifier is unique to this connection.

 **EOL** *string*
Default: ""

The [EOL](#PipeConnection_f_EOL) field is used to define boundaries in the input stream using the value of the field.

The [EOL](#PipeConnection_f_EOL) field is especially useful with ASCII files. By setting it to CRLF (*"\r\n"*) , the incoming ASCII text stream can be split into lines. In this case, one event is fired for each line received (as well as in packet boundaries). The CRLF (*"\r\n"*) . bytes are discarded.

The [EOL](#PipeConnection_f_EOL) field is a binary string. This means that it can be more than one byte long, and it can contain NULL bytes.

 **EOLB** *byte []*
Default: ""

The [EOL](#PipeConnection_f_EOL) field is used to define boundaries in the input stream using the value of the field.

The [EOL](#PipeConnection_f_EOL) field is especially useful with ASCII files. By setting it to CRLF (*"\r\n"*) , the incoming ASCII text stream can be split into lines. In this case, one event is fired for each line received (as well as in packet boundaries). The CRLF (*"\r\n"*) . bytes are discarded.

The [EOL](#PipeConnection_f_EOL) field is a binary string. This means that it can be more than one byte long, and it can contain NULL bytes.

 **MaxLineLength** *int*
Default: 2048

This field is the size of an internal buffer that holds received data while waiting for an [EOL](#PipeConnection_f_EOL) string.

If an [EOL](#PipeConnection_f_EOL) string is found in the input stream before [MaxLineLength](#PipeConnection_f_MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset.

If no EOL is found, and [MaxLineLength](#PipeConnection_f_MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset.

The minimum value for [MaxLineLength](#PipeConnection_f_MaxLineLength) is 256 bytes. The default value is 2048 bytes.

 **SingleLineMode** *bool*
Default: False

This field shows the special mode for line-oriented protocols. When SingleLineMode is True, the component treats the incoming data stream as lines separated by carriage return (CR), line feed (LF), or CRLF. The EOL property is ignored.

 **Timeout** *int*
Default: 0

This field specifies a timeout for the component.

 This field 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 will be sent synchronously. When SSLEnabled is True, all data is sent synchronously regardless of the [Timeout](#PipeConnection_f_Timeout) value. Please see the following notes for details.

**Plaintext**

If the [Timeout](#PipeConnection_f_Timeout) field is set to 0, all operations return immediately, potentially failing with a *WOULDBLOCK* error if data cannot be sent immediately.

If [Timeout](#PipeConnection_f_Timeout) is set to a positive value, data is sent in a blocking manner and the component will wait for the operation to complete before returning control. The component will handle any potential *WOULDBLOCK* errors internally and automatically retry the operation for a maximum of [Timeout](#PipeConnection_f_Timeout) seconds.

**SSL**

If the [Timeout](#PipeConnection_f_Timeout) field is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If [Timeout](#PipeConnection_f_Timeout) is set to a positive value, the component will wait for the operation to complete before returning control.

**Additional Notes**

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the component throws an exception.

NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the [Timeout](#PipeConnection_f_Timeout) field is 0 (asynchronous for plaintext, synchronous for SSL).

## Constructors

```text
public PipeConnection();
```

# Config Settings ([PipeServer](#pipeserver-component) Component)

 The component accepts one or more of the following *configuration settings*. Configuration 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](#config-method-pipeserver-component) method.

### PipeServer Config Settings

**CloseStreamAfterTransfer**: If true, the component will close the upload or download stream after the transfer.This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True.

**CustomSecurityDescription**: A custom security descriptor to define access to the pipe.Specified in the Security Descriptor Definition Language format. For example, if there is an instance of PipeServer running as a Windows Service, the correct SDDL string must used in the Config method for a Desktop app to access the pipe, like so: PipeServer1.Config("CustomSecurityDescription=D:(A;OICI;GRGW;;;AU)");

**InBufferSize**: The size in bytes of the output buffer.This setting specifies the size in bytes of the output buffer. Small buffer sizes may reduce overall performance. The default value is "65536".

**OutBufferSize**: The size in bytes of the input buffer.This setting specifies the size in bytes of the input buffer. Small buffer sizes may reduce overall performance. The default value is "65536".

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**GUIAvailable**: Whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting [GUIAvailable](#GUIAvailable) to *false* will ensure that the component does not attempt to process external events.

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseFIPSCompliantAPI**: Tells the component whether or not to use FIPS certified APIs.When set to *true*, the component will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article.

NOTE: This setting is applicable only on Windows.

NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to *true*.

Setting this configuration setting to *true* tells the component to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

NOTE: This setting is static. The value set is applicable to all components used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.

# Trappable Errors ([PipeServer](#pipeserver-component) Component)

### PipeServer Errors

|  |  |
| --- | --- |
| 401 | Failed to create event. |
| 402 | Failed to create security descriptor. |
| 403 | Error creating named pipe. |
| 404 | Error connecting to named pipe. |
| 405 | Error disconnecting named pipe. |
| 408 | Error sending data. |
| 410 | Invalid MaxLineLength value. |
| 411 | Error reading data. |
| 412 | Error invoking RegisterWaitForSingleObject. |
| 413 | Operation would block. |
| 414 | Named pipe does not exist. |
| 415 | Named pipe is already connected. |
| 416 | Error connecting to named pipe. |
| 417 | Named pipe not connected. |
| 419 | Unsupported operation, see error message for details. |
| 424 | Invalid ConnectionID. |