# PipeClient Component

The PipeClient component is a simple client for connecting and communicating over named pipes.

## Syntax

```text
nsoftware.IPWorksIPC.PipeClient
```

## Remarks

The PipeClient component is used to connect to an existing pipe server. After connecting the transfer of data is handled very similarly to socket communication.

To begin, first set [PipeName](#pipename-property-pipeclient-component) to the name of the pipe to which the connection will be made. Call [Connect](#connect-method-pipeclient-component) or set [Connected](#connected-event-pipeclient-component) to True to establish the connection. The [Connected](#connected-event-pipeclient-component) event will fire when the connection is complete.

After connecting call [Send](#send-method-pipeclient-component) or [SendFile](#sendfile-method-pipeclient-component) to send data. Incoming data is received through the [DataIn](#datain-event-pipeclient-component) event.

To disconnect call [Disconnect](#disconnect-method-pipeclient-component) or set [Connected](#connected-property-pipeclient-component) to False.

**Synchronous and Asynchronous Operation**

If the [Timeout](#timeout-property-pipeclient-component) property is set to 0, the component will behave asynchronously and all operations return immediately, potentially failing with an error if they can't be completed immediately.

If [Timeout](#timeout-property-pipeclient-component) is set to a positive value, the component will behave synchronously and wait for the operation to complete before returning control.

The component will use [DoEvents](#doevents-method-pipeclient-component) 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](#timeout-property-pipeclient-component) 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](#timeout-property-pipeclient-component) seconds when any amount of data is successfully sent or received.

The default value for the [Timeout](#timeout-property-pipeclient-component) property is 60 seconds.

## Property List

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

|  |  |
| --- | --- |
| [AcceptData](#acceptdata-property-pipeclient-component) | This property indicates whether data reception is currently enabled. |
| [BytesSent](#bytessent-property-pipeclient-component) | This property includes the number of bytes actually sent after a call to the [SendBytes](#sendbytes-method-pipeclient-component) method. |
| [Connected](#connected-property-pipeclient-component) | Triggers a connection or disconnection. |
| [EOL](#eol-property-pipeclient-component) | This property is used to break the incoming data stream into chunks separated by EOL . |
| [PipeName](#pipename-property-pipeclient-component) | The name of the pipe. |
| [RecordLength](#recordlength-property-pipeclient-component) | The length of received data records. |
| [SingleLineMode](#singlelinemode-property-pipeclient-component) | This property includes a special mode for line-oriented protocols. |
| [Timeout](#timeout-property-pipeclient-component) | This property includes the timeout for the component. |

## 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-pipeclient-component) | Sets or retrieves a configuration setting. |
| [Connect](#connect-method-pipeclient-component) | Connects to a named pipe. |
| [Disconnect](#disconnect-method-pipeclient-component) | Disconnects from the named pipe. |
| [DoEvents](#doevents-method-pipeclient-component) | This method processes events from the internal message queue. |
| [GetLine](#getline-method-pipeclient-component) | This method gets a line of text from the server. |
| [Interrupt](#interrupt-method-pipeclient-component) | This method interrupts the current action. |
| [ProcessData](#processdata-method-pipeclient-component) | This method reenables data reception after a call to [PauseData](#PipeClient_m_PauseData) . |
| [Send](#send-method-pipeclient-component) | Sends data over the connected pipe. |
| [SendBytes](#sendbytes-method-pipeclient-component) | This method sends binary data over the connected pipe. |
| [SendFile](#sendfile-method-pipeclient-component) | Sends the file over the connected pipe. |
| [SendLine](#sendline-method-pipeclient-component) | This method sends a string followed by a newline. |
| [SendText](#sendtext-method-pipeclient-component) | This method sends text over the connected pipe. |
| [SetReceiveStream](#setreceivestream-method-pipeclient-component) | This method sets the stream to which received data will be written. |
| [SetSendStream](#setsendstream-method-pipeclient-component) | This method reads content from the stream and sends it to 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.*

|  |  |
| --- | --- |
| [Connected](#connected-event-pipeclient-component) | Fired immediately after a connection completes. |
| [DataIn](#datain-event-pipeclient-component) | This event is fired when data (complete lines) come in. |
| [Disconnected](#disconnected-event-pipeclient-component) | Fired when a connection is closed. |
| [Error](#error-event-pipeclient-component) | Fired when information is available about errors during data delivery. |
| [ReadyToSend](#readytosend-event-pipeclient-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.*

|  |  |
| --- | --- |
| [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| [CloseStreamAfterTransfer](#CloseStreamAfterTransfer) | If true, the component will close the upload or download stream after the transfer. |
| [InBufferSize](#InBufferSize) | The size in bytes of the output buffer. |
| [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the input buffer. |
| [PipeDirection](#PipeDirection) | Determines the direction data flows. |
| [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. |

# AcceptData Property ([PipeClient](#pipeclient-component) Component)

This property indicates whether data reception is currently enabled.

## Syntax

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

## Default Value

True

## Remarks

This property indicates whether data reception is currently enabled. When *false*, data reception is disabled and the [DataIn](#datain-event-pipeclient-component) event will not fire. Use the PauseData and [ProcessData](#processdata-method-pipeclient-component) methods to pause and resume data reception.

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

# BytesSent Property ([PipeClient](#pipeclient-component) Component)

This property includes the number of bytes actually sent after a call to the [SendBytes](#sendbytes-method-pipeclient-component) method.

## Syntax

```text
public int BytesSent { get; }
```

## Default Value

0

## Remarks

This property indicates how many bytes were sent after the last call to [SendBytes](#sendbytes-method-pipeclient-component). Please check the [SendBytes](#sendbytes-method-pipeclient-component) method for more information.

NOTE: that BytesSent will always return 0 when the component is operating in synchronous mode (i.e., the [Timeout](#timeout-property-pipeclient-component) property is set to a positive value.)

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

# Connected Property ([PipeClient](#pipeclient-component) Component)

Triggers a connection or disconnection.

## Syntax

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

## Default Value

False

## Remarks

This property indicates whether the component is connected to the remote host. Use the [Connect](#connect-method-pipeclient-component) and [Disconnect](#disconnect-method-pipeclient-component) methods to manage the connection.

This property triggers a connection or disconnection. Setting this property to True makes the component attempt to connect to the pipe identified by the [PipeName](#pipename-property-pipeclient-component) property. If successful, after the connection is achieved the value of the property changes to True and the [Connected](#connected-event-pipeclient-component) event is fired.

Setting this property to False closes the connection.

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

# EOL Property ([PipeClient](#pipeclient-component) Component)

This property is used to break the incoming data stream into chunks separated by * EOL * .

## Syntax

```text
public string EOL { get; set; }
public byte[] EOLB { get; set; }
```

## Default Value

""

## Remarks

This property is used to define boundaries in the input stream using the value of the property.

This property is especially useful with ASCII files. Setting it to CRLF (*"\r\n"*) enables the incoming ASCII text stream to split into defined 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.

This property is a binary string. Notably, this means that it can be more than one byte long, and it can contain NULL bytes.

# PipeName Property ([PipeClient](#pipeclient-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.

This may be the name by itself, for instance "MyPipe", or in the format "\\.\pipe\MyPipe".

# RecordLength Property ([PipeClient](#pipeclient-component) Component)

The length of received data records.

## Syntax

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

## Default Value

0

## Remarks

If set to a positive value, this property defines the length of data records to be received. The component will accumulate data until RecordLength is reached and only then fire the [DataIn](#datain-event-pipeclient-component) event with data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time, including within the [DataIn](#datain-event-pipeclient-component) event.

The default value is 0, meaning this property is not used.

This property is not available at design time.

# SingleLineMode Property ([PipeClient](#pipeclient-component) Component)

This property includes a special mode for line-oriented protocols.

## Syntax

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

## Default Value

False

## Remarks

When this property is set to True, the component treats the incoming data stream as lines separated by carriage return line feed (CRLF), CR, or LF. The [EOL](#eol-property-pipeclient-component) property is ignored.

When this property is set to True, [AcceptData](#acceptdata-property-pipeclient-component) automatically will be set to False. Please refer to the [GetLine](#getline-method-pipeclient-component) method for more information.

This property is not available at design time.

# Timeout Property ([PipeClient](#pipeclient-component) Component)

This property includes the timeout for the component.

## Syntax

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

## Default Value

60

## Remarks

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 is sent synchronously regardless of the Timeout value. Please see the notes below for details.

**Plaintext**

If the Timeout property is set to 0, all operations return immediately, potentially failing with a *WOULDBLOCK* error if data cannot be sent immediately.

If 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 seconds.

**SSL**

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If 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](#doevents-method-pipeclient-component) 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 property is 60 seconds.

# Config Method ([PipeClient](#pipeclient-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-pipeclient-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-pipeclient-component), you must call *Config("PROPERTY")*. The value will be returned as a string.

# Connect Method ([PipeClient](#pipeclient-component) Component)

Connects to a named pipe.

## Syntax

```text
public void Connect();

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

## Remarks

This method connects to a named pipe specified by [PipeName](#pipename-property-pipeclient-component). Calling this method is equivalent to setting the [Connected](#connected-property-pipeclient-component) property to True.

**Example (Connecting)**

```text
PipeClient.PipeName = "MyPipe";
PipeClient.Connect();
```

# Disconnect Method ([PipeClient](#pipeclient-component) Component)

Disconnects from the named pipe.

## Syntax

```text
public void Disconnect();

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

## Remarks

This method disconnects from the pipe. Calling this method is equivalent to setting the [Connected](#connected-property-pipeclient-component) property to False.

# DoEvents Method ([PipeClient](#pipeclient-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.

# GetLine Method ([PipeClient](#pipeclient-component) Component)

This method gets a line of text from the server.

## Syntax

```text
public string GetLine();

Async Version
public async Task<string> GetLine();
public async Task<string> GetLine(CancellationToken cancellationToken);
```

## Remarks

This method gets a line of text from the server. This method is an alternative method of receiving data for line-oriented protocols. The component will block if necessary and then will return the received line. [AcceptData](#acceptdata-property-pipeclient-component) will be set automatically to True when the method is called, and then will be set to False after a line is received.

Please refer to the [SingleLineMode](#singlelinemode-property-pipeclient-component) property for more information.

# Interrupt Method ([PipeClient](#pipeclient-component) Component)

This method interrupts the current action.

## Syntax

```text
public void Interrupt();

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

## Remarks

This method interrupts the current action. If you use [SendFile](#sendfile-method-pipeclient-component) to upload a file, the component will run synchronously until the upload is completed. This method will allow you to stop the file from uploading without disconnecting from the host.

# ProcessData Method ([PipeClient](#pipeclient-component) Component)

This method reenables data reception after a call to [PauseData](#PipeClient_m_PauseData) .

## Syntax

```text
public void ProcessData();

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

## Remarks

This method reenables data reception after a previous call to PauseData. When PauseData is called, the [DataIn](#datain-event-pipeclient-component) event will not fire. To reenable data reception and allow [DataIn](#datain-event-pipeclient-component) to fire, call this method.

NOTE: This method is used only after previously calling PauseData. It does not need to be called to process incoming data by default.

# Send Method ([PipeClient](#pipeclient-component) Component)

Sends data over the connected pipe.

## Syntax

```text
public void Send(byte[] text);

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

## Remarks

This method sends data to the server.

# SendBytes Method ([PipeClient](#pipeclient-component) Component)

This method sends binary data over the connected pipe.

## Syntax

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

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

## Remarks

This method sends the specified binary data to the server. To send text, use the [SendText](#sendtext-method-pipeclient-component) method instead.

When [Timeout](#timeout-property-pipeclient-component) is set to 0 the component will behave asynchronously. If you are sending data to the receiving process faster than it can process it, the outgoing queue might fill up. When this happens, the component fails with exception 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. The [BytesSent](#bytessent-property-pipeclient-component) property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the [ReadyToSend](#readytosend-event-pipeclient-component) event before attempting to send data again. (However, please note that [ReadyToSend](#readytosend-event-pipeclient-component) is not fired when part of the data is successfully sent).

# SendFile Method ([PipeClient](#pipeclient-component) Component)

Sends the file over the connected pipe.

## Syntax

```text
public void SendFile(string fileName);

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

## Remarks

This method sends the specified file to the server/process over the connected pipe.

Timeout must be set to a positive value so that the component will operate synchronously.

# SendLine Method ([PipeClient](#pipeclient-component) Component)

This method sends a string followed by a newline.

## Syntax

```text
public void SendLine(string text);

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

## Remarks

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

Please refer to the [GetLine](#getline-method-pipeclient-component) method and [SingleLineMode](#singlelinemode-property-pipeclient-component) property for more information.

# SendText Method ([PipeClient](#pipeclient-component) Component)

This method sends text over the connected pipe.

## Syntax

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

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

## Remarks

This method sends the specified text to the server. To send binary data, use the [SendBytes](#sendbytes-method-pipeclient-component) method instead.

When [Timeout](#timeout-property-pipeclient-component) is set to 0 the component will behave asynchronously. If you are sending data to the receiving process faster than it can process it, the outgoing queue might fill up. When this happens, the component fails with exception 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. The [BytesSent](#bytessent-property-pipeclient-component) property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the [ReadyToSend](#readytosend-event-pipeclient-component) event before attempting to send data again. (However, please note that [ReadyToSend](#readytosend-event-pipeclient-component) is not fired when part of the data is successfully sent).

# SetReceiveStream Method ([PipeClient](#pipeclient-component) Component)

This method sets the stream to which received data will be written.

## Syntax

```text
public void SetReceiveStream(System.IO.Stream receiveStream);

Async Version
public async Task SetReceiveStream(System.IO.Stream receiveStream);
public async Task SetReceiveStream(System.IO.Stream receiveStream, CancellationToken cancellationToken);
```

## Remarks

This method sets the stream to which received data will be written. The stream should be open and normally set to position 0. The component will write all incoming data to this stream. The downloaded content will be written starting at the current position in the stream.

# SetSendStream Method ([PipeClient](#pipeclient-component) Component)

This method reads content from the stream and sends it to the server.

## Syntax

```text
public void SetSendStream(System.IO.Stream sendStream);

Async Version
public async Task SetSendStream(System.IO.Stream sendStream);
public async Task SetSendStream(System.IO.Stream sendStream, CancellationToken cancellationToken);
```

## Remarks

This method reads content from the stream and sends it to the server. The stream should be open and normally set to position 0. The call will return only after the end of stream has been reached. The component will automatically close this stream if [CloseStreamAfterTransfer](#CloseStreamAfterTransfer) is set to True (default). The content will be read starting at the current position in the stream.

This method requires [Timeout](#timeout-property-pipeclient-component) be set to a positive value. This allows the component to ensure that the data are transferred completely without a *WOULDBLOCK* error. See [Timeout](#timeout-property-pipeclient-component) for details.

# Connected Event ([PipeClient](#pipeclient-component) Component)

Fired immediately after a connection completes.

## Syntax

```text
public event OnConnectedHandler OnConnected;

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

public class PipeClientConnectedEventArgs : EventArgs {
}
```

## Remarks

When the connection is successfully established this event will fire.

# DataIn Event ([PipeClient](#pipeclient-component) Component)

This event is fired when data (complete lines) come in.

## Syntax

```text
public event OnDataInHandler OnDataIn;

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

public class PipeClientDataInEventArgs : EventArgs {
  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. The incoming data are provided through the *Text* parameter.

*EOL* indicates whether or not the [EOL](#eol-property-pipeclient-component) string was found at the end of *Text*. If the [EOL](#eol-property-pipeclient-component) string was found, then *EOL* is True.

If *Text* is part of a data portion of length larger than [MaxLineLength](#MaxLineLength) with no [EOL](#eol-property-pipeclient-component) strings in it, then *EOL* is False. NOTE: This means that one or more DataIn events with *EOL* set to False can be received during a connection.

If the [EOL](#eol-property-pipeclient-component) 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 ([PipeClient](#pipeclient-component) Component)

Fired when a connection is closed.

## Syntax

```text
public event OnDisconnectedHandler OnDisconnected;

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

public class PipeClientDisconnectedEventArgs : EventArgs {
}
```

## Remarks

When the connection is closed this event will fire.

# Error Event ([PipeClient](#pipeclient-component) Component)

Fired when information is available about errors during data delivery.

## Syntax

```text
public event OnErrorHandler OnError;

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

public class PipeClientErrorEventArgs : EventArgs {
  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.

The *ErrorCode* parameter contains an error code, and the *Description* parameter 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-pipeclient-component) section.

# ReadyToSend Event ([PipeClient](#pipeclient-component) Component)

Fired when the component is ready to send data.

## Syntax

```text
public event OnReadyToSendHandler OnReadyToSend;

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

public class PipeClientReadyToSendEventArgs : EventArgs {
}
```

## Remarks

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

# Config Settings ([PipeClient](#pipeclient-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-pipeclient-component) method.

### PipeClient Config Settings

**AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If **AbsoluteTimeout** is set to *true*, any method which does not complete within Timeout seconds will be aborted. By default, *AbsoluteTimeout* is *false*, and the timeout is an inactivity timeout.

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

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

**MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an [EOL](#eol-property-pipeclient-component) string.

If an [EOL](#eol-property-pipeclient-component) string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the [DataIn](#datain-event-pipeclient-component) event is fired with the *EOL* parameter set to *true*, and the buffer is reset.

If no [EOL](#eol-property-pipeclient-component) is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the [DataIn](#datain-event-pipeclient-component) event is fired with the *EOL* parameter set to *false*, and the buffer is reset.

The default value is 2048 bytes. The maximum value is 65536 bytes.

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

**PipeDirection**: Determines the direction data flows.Pipe servers are sometimes configured to only send or only receive data (a direction), which can cause [Connect](#connect-method-pipeclient-component) to fail if [PipeDirection](#PipeDirection) is not set accordingly. Set this to match the direction of the pipe server. Valid values are:

|  |  |
| --- | --- |
| 1 | In. The server can only receive data. |
| 2 | Out. The server can only send data. |
| 3 | In/Out (default). The server can both receive and send data. |

### 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 ([PipeClient](#pipeclient-component) Component)

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