# PipeClient Class

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

## Syntax

```text
PipeClient
```

## Remarks

The PipeClient class 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-class) to the name of the pipe to which the connection will be made. Call [Connect](#connect-method-pipeclient-class) or set [Connected](#connected-event-pipeclient-class) to True to establish the connection. The [Connected](#connected-event-pipeclient-class) event will fire when the connection is complete.

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

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

**Synchronous and Asynchronous Operation**

If the [Timeout](#timeout-property-pipeclient-class) property is set to 0, the class 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-class) is set to a positive value, the class will behave synchronously and wait for the operation to complete before returning control.

The class will use [DoEvents](#doevents-method-pipeclient-class) 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-class) expires, and the operation is not yet complete, the class fails with an error.

NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by [Timeout](#timeout-property-pipeclient-class) seconds when any amount of data is successfully sent or received.

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

## Property List

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

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

## Method List

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

|  |  |
| --- | --- |
| [Config](#config-method-pipeclient-class) | Sets or retrieves a configuration setting. |
| [Connect](#connect-method-pipeclient-class) | Connects to a named pipe. |
| [Disconnect](#disconnect-method-pipeclient-class) | Disconnects from the named pipe. |
| [DoEvents](#doevents-method-pipeclient-class) | This method processes events from the internal message queue. |
| [GetLine](#getline-method-pipeclient-class) | This method gets a line of text from the server. |
| [Interrupt](#interrupt-method-pipeclient-class) | This method interrupts the current action. |
| [ProcessData](#processdata-method-pipeclient-class) | This method reenables data reception after a call to PauseData . |
| [Send](#send-method-pipeclient-class) | Sends data over the connected pipe. |
| [SendBytes](#sendbytes-method-pipeclient-class) | This method sends binary data over the connected pipe. |
| [SendFile](#sendfile-method-pipeclient-class) | Sends the file over the connected pipe. |
| [SendLine](#sendline-method-pipeclient-class) | This method sends a string followed by a newline. |
| [SendText](#sendtext-method-pipeclient-class) | This method sends text over the connected pipe. |

## Event List

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

|  |  |
| --- | --- |
| [Connected](#connected-event-pipeclient-class) | Fired immediately after a connection completes. |
| [DataIn](#datain-event-pipeclient-class) | This event is fired when data (complete lines) come in. |
| [Disconnected](#disconnected-event-pipeclient-class) | Fired when a connection is closed. |
| [Error](#error-event-pipeclient-class) | Fired when information is available about errors during data delivery. |
| [ReadyToSend](#readytosend-event-pipeclient-class) | Fired when the class is ready to send data. |

## Config Settings

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

|  |  |
| --- | --- |
| [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| [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. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. |
| [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class 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-class) Class)

This property indicates whether data reception is currently enabled.

## Syntax

```text
ANSI (Cross Platform)
int GetAcceptData();

Unicode (Windows)
BOOL GetAcceptData();
```

## 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-class) event will not fire. Use the PauseData and [ProcessData](#processdata-method-pipeclient-class) methods to pause and resume data reception.

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

## Data Type

Boolean

# BytesSent Property ([PipeClient](#pipeclient-class) Class)

This property includes the number of bytes actually sent after a call to the SendBytes method.

## Syntax

```text
ANSI (Cross Platform)
int GetBytesSent();

Unicode (Windows)
INT GetBytesSent();
```

## Default Value

0

## Remarks

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

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

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

## Data Type

Integer

# Connected Property ([PipeClient](#pipeclient-class) Class)

Triggers a connection or disconnection.

## Syntax

```text
ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();
```

## Default Value

FALSE

## Remarks

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

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

Setting this property to False closes the connection.

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

## Data Type

Boolean

# EOL Property ([PipeClient](#pipeclient-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetEOL(char* &lpEOL, int &lenEOL);int SetEOL(const char* lpEOL, int lenEOL);

Unicode (Windows)
INT GetEOL(LPSTR &lpEOL, INT &lenEOL);INT SetEOL(LPCSTR lpEOL, INT lenEOL);
```

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

## Data Type

Binary String

# PipeName Property ([PipeClient](#pipeclient-class) Class)

The name of the pipe.

## Syntax

```text
ANSI (Cross Platform)
char* GetPipeName();int SetPipeName(const char* lpszPipeName);

Unicode (Windows)
LPWSTR GetPipeName();INT SetPipeName(LPCWSTR lpszPipeName);
```

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

## Data Type

String

# RecordLength Property ([PipeClient](#pipeclient-class) Class)

The length of received data records.

## Syntax

```text
ANSI (Cross Platform)
int GetRecordLength();int SetRecordLength(int iRecordLength);

Unicode (Windows)
INT GetRecordLength();INT SetRecordLength(INT iRecordLength);
```

## Default Value

0

## Remarks

If set to a positive value, this property defines the length of data records to be received. The class will accumulate data until RecordLength is reached and only then fire the [DataIn](#datain-event-pipeclient-class) 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-class) event.

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

This property is not available at design time.

## Data Type

Integer

# SingleLineMode Property ([PipeClient](#pipeclient-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetSingleLineMode();int SetSingleLineMode(int bSingleLineMode);

Unicode (Windows)
BOOL GetSingleLineMode();INT SetSingleLineMode(BOOL bSingleLineMode);
```

## Default Value

FALSE

## Remarks

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

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

This property is not available at design time.

## Data Type

Boolean

# Timeout Property ([PipeClient](#pipeclient-class) Class)

This property includes the timeout for the class.

## Syntax

```text
ANSI (Cross Platform)
int GetTimeout();int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();INT SetTimeout(INT iTimeout);
```

## Default Value

60

## Remarks

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 class will wait for the operation to complete before returning control. The class will handle any potential *WOULDBLOCK* errors internally and automatically retry the operation for a maximum of Timeout seconds.

The class will use [DoEvents](#doevents-method-pipeclient-class) 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 class fails with an error.

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.

## Data Type

Integer

# Config Method ([PipeClient](#pipeclient-class) Class)

Sets or retrieves a configuration setting.

## Syntax

```text
ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-pipeclient-class) for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# Connect Method ([PipeClient](#pipeclient-class) Class)

Connects to a named pipe.

## Syntax

```text
ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();
```

## Remarks

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

**Example (Connecting)**

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Disconnect Method ([PipeClient](#pipeclient-class) Class)

Disconnects from the named pipe.

## Syntax

```text
ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();
```

## Remarks

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# DoEvents Method ([PipeClient](#pipeclient-class) Class)

This method processes events from the internal message queue.

## Syntax

```text
ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();
```

## Remarks

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# GetLine Method ([PipeClient](#pipeclient-class) Class)

This method gets a line of text from the server.

## Syntax

```text
ANSI (Cross Platform)
char* GetLine();

Unicode (Windows)
LPWSTR GetLine();
```

## 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 class will block if necessary and then will return the received line. [AcceptData](#acceptdata-property-pipeclient-class) 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-class) property for more information.

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# Interrupt Method ([PipeClient](#pipeclient-class) Class)

This method interrupts the current action.

## Syntax

```text
ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();
```

## Remarks

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# ProcessData Method ([PipeClient](#pipeclient-class) Class)

This method reenables data reception after a call to PauseData .

## Syntax

```text
ANSI (Cross Platform)
int ProcessData();

Unicode (Windows)
INT ProcessData();
```

## Remarks

This method reenables data reception after a previous call to PauseData. When PauseData is called, the [DataIn](#datain-event-pipeclient-class) event will not fire. To reenable data reception and allow [DataIn](#datain-event-pipeclient-class) 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.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Send Method ([PipeClient](#pipeclient-class) Class)

Sends data over the connected pipe.

## Syntax

```text
ANSI (Cross Platform)
int Send(const char* lpText, int lenText);

Unicode (Windows)
INT Send(LPCSTR lpText, INT lenText);
```

## Remarks

This method sends data to the server.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SendBytes Method ([PipeClient](#pipeclient-class) Class)

This method sends binary data over the connected pipe.

## Syntax

```text
ANSI (Cross Platform)
int SendBytes(const char* lpData, int lenData);

Unicode (Windows)
INT SendBytes(LPCSTR lpData, INT lenData);
```

## Remarks

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

When [Timeout](#timeout-property-pipeclient-class) is set to 0 the class 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 class fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. The [BytesSent](#bytessent-property-pipeclient-class) property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the [ReadyToSend](#readytosend-event-pipeclient-class) event before attempting to send data again. (However, please note that [ReadyToSend](#readytosend-event-pipeclient-class) is not fired when part of the data is successfully sent).

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SendFile Method ([PipeClient](#pipeclient-class) Class)

Sends the file over the connected pipe.

## Syntax

```text
ANSI (Cross Platform)
int SendFile(const char* lpszFileName);

Unicode (Windows)
INT SendFile(LPCWSTR lpszFileName);
```

## 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 class will operate synchronously.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SendLine Method ([PipeClient](#pipeclient-class) Class)

This method sends a string followed by a newline.

## Syntax

```text
ANSI (Cross Platform)
int SendLine(const char* lpszText);

Unicode (Windows)
INT SendLine(LPCWSTR lpszText);
```

## 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-class) method and [SingleLineMode](#singlelinemode-property-pipeclient-class) property for more information.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SendText Method ([PipeClient](#pipeclient-class) Class)

This method sends text over the connected pipe.

## Syntax

```text
ANSI (Cross Platform)
int SendText(const char* lpszText);

Unicode (Windows)
INT SendText(LPCWSTR lpszText);
```

## Remarks

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

When [Timeout](#timeout-property-pipeclient-class) is set to 0 the class 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 class fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. The [BytesSent](#bytessent-property-pipeclient-class) property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the [ReadyToSend](#readytosend-event-pipeclient-class) event before attempting to send data again. (However, please note that [ReadyToSend](#readytosend-event-pipeclient-class) is not fired when part of the data is successfully sent).

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Connected Event ([PipeClient](#pipeclient-class) Class)

Fired immediately after a connection completes.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireConnected(PipeClientConnectedEventParams *e);
typedef struct {
  int reserved;
} PipeClientConnectedEventParams;

Unicode (Windows)
virtual INT FireConnected(PipeClientConnectedEventParams *e);
typedef struct {
  INT reserved;
} PipeClientConnectedEventParams;
```

## Remarks

When the connection is successfully established this event will fire.

# DataIn Event ([PipeClient](#pipeclient-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
virtual int FireDataIn(PipeClientDataInEventParams *e);
typedef struct {  const char *Text;
  int lenText;  int EOL;
  int reserved;
} PipeClientDataInEventParams;

Unicode (Windows)
virtual INT FireDataIn(PipeClientDataInEventParams *e);
typedef struct {  LPCSTR Text;
  INT lenText;  BOOL EOL;
  INT reserved;
} PipeClientDataInEventParams;
```

## 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-class) string was found at the end of *Text*. If the [EOL](#eol-property-pipeclient-class) 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-class) 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-class) 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-class) Class)

Fired when a connection is closed.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireDisconnected(PipeClientDisconnectedEventParams *e);
typedef struct {
  int reserved;
} PipeClientDisconnectedEventParams;

Unicode (Windows)
virtual INT FireDisconnected(PipeClientDisconnectedEventParams *e);
typedef struct {
  INT reserved;
} PipeClientDisconnectedEventParams;
```

## Remarks

When the connection is closed this event will fire.

# Error Event ([PipeClient](#pipeclient-class) Class)

Fired when information is available about errors during data delivery.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireError(PipeClientErrorEventParams *e);
typedef struct {  int ErrorCode;  const char *Description;
  int reserved;
} PipeClientErrorEventParams;

Unicode (Windows)
virtual INT FireError(PipeClientErrorEventParams *e);
typedef struct {  INT ErrorCode;  LPCWSTR Description;
  INT reserved;
} PipeClientErrorEventParams;
```

## Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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-class) section.

# ReadyToSend Event ([PipeClient](#pipeclient-class) Class)

Fired when the class is ready to send data.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireReadyToSend(PipeClientReadyToSendEventParams *e);
typedef struct {
  int reserved;
} PipeClientReadyToSendEventParams;

Unicode (Windows)
virtual INT FireReadyToSend(PipeClientReadyToSendEventParams *e);
typedef struct {
  INT reserved;
} PipeClientReadyToSendEventParams;
```

## 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-class) Class)

 The class 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 class, access to these *internal properties* is provided through the [Config](#config-method-pipeclient-class) 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.

**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-class) string.

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

If no [EOL](#eol-property-pipeclient-class) is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the [DataIn](#datain-event-pipeclient-class) 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-class) 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.

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class 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*.

**ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

**SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when [DoEvents](#doevents-method-pipeclient-class) is called, the class will wait for the amount of time specified here before returning. The default value is 20.

**UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *true*, the class 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.

On Linux, the C++ edition requires installation of the FIPS-enabled OpenSSL library. The OpenSSL FIPS provider version must be at least 3.0.0. For additional information and instructions regarding the installation and activation of the FIPS-enabled OpenSSL library, please refer to the following link: [https://github.com/openssl/openssl/blob/master/README-FIPS.md](https://github.com/openssl/openssl/blob/master/README-FIPS.md)

To ensure the class utilizes the FIPS-enabled OpenSSL library, the obfuscated source code should first be compiled with OpenSSL enabled, as described in the Supported Platforms section. Additionally, the FIPS module should be enabled and active. If the obfuscated source code is not compiled as mentioned, or the FIPS module is inactive, the class will throw an appropriate error assuming FIPS mode is enabled.

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 classes 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 class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class 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.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([PipeClient](#pipeclient-class) Class)

## Error Handling (C++)

Call the *GetLastErrorCode()* method to obtain the last called method's result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

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