# PipeServer Class

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

## Syntax

```text
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 class has a minimum of properties, and events: [Connected](#connected-event-pipeserver-class), [DataIn](#datain-event-pipeserver-class), [Disconnected](#disconnected-event-pipeserver-class), [ReadyToSend](#readytosend-event-pipeserver-class), and [Error](#error-event-pipeserver-class).

PipeServer can start to listen on a pipe by setting [PipeName](#pipename-property-pipeserver-class) and then setting [Listening](#listening-property-pipeserver-class) to True. When a client connects the [Connected](#connected-event-pipeserver-class) 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 class with short descriptions. Click on the links for further details.*

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

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

## 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-pipeserver-class) | Fired immediately after a connection completes. |
| [DataIn](#datain-event-pipeserver-class) | This event is fired when data come in. |
| [Disconnected](#disconnected-event-pipeserver-class) | Fires when a client disconnects. |
| [Error](#error-event-pipeserver-class) | This event fires information about errors during data delivery. |
| [ReadyToSend](#readytosend-event-pipeserver-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.*

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

# Connections Property ([PipeServer](#pipeserver-class) Class)

A collection of currently connected clients.

## Syntax

```text
IPWorksIPCList<IPWorksIPCPipeConnection>* GetConnections();
```

## 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-class) event fires when a client connects and provides the Connection Id (key) that identifies the client.

**Example (Broadcasting Data)**

```text
For i = 0 to Control.ConnectionCount
  Control.DataToSend(Control.ConnectionId(i)) = "Broadcast Data"
Next i
```

This property is read-only.

## Data Type

[IPWorksIPCPipeConnection](#pipeconnection-type)

# DefaultEOL Property ([PipeServer](#pipeserver-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetDefaultEOL(char* &lpDefaultEOL, int &lenDefaultEOL);int SetDefaultEOL(const char* lpDefaultEOL, int lenDefaultEOL);

Unicode (Windows)
INT GetDefaultEOL(LPSTR &lpDefaultEOL, INT &lenDefaultEOL);INT SetDefaultEOL(LPCSTR lpDefaultEOL, INT lenDefaultEOL);
```

## Default Value

""

## Remarks

This property contains a default end-of-line (EOL) value to be used by incoming connections. Once the class 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.

## Data Type

Binary String

# DefaultMaxLineLength Property ([PipeServer](#pipeserver-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetDefaultMaxLineLength();int SetDefaultMaxLineLength(int iDefaultMaxLineLength);

Unicode (Windows)
INT GetDefaultMaxLineLength();INT SetDefaultMaxLineLength(INT iDefaultMaxLineLength);
```

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

## Data Type

Integer

# DefaultSingleLineMode Property ([PipeServer](#pipeserver-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetDefaultSingleLineMode();int SetDefaultSingleLineMode(int bDefaultSingleLineMode);

Unicode (Windows)
BOOL GetDefaultSingleLineMode();INT SetDefaultSingleLineMode(BOOL bDefaultSingleLineMode);
```

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

## Data Type

Boolean

# DefaultTimeout Property ([PipeServer](#pipeserver-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetDefaultTimeout();int SetDefaultTimeout(int iDefaultTimeout);

Unicode (Windows)
INT GetDefaultTimeout();INT SetDefaultTimeout(INT iDefaultTimeout);
```

## Default Value

0

## Remarks

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

By default, the timeout is 0, meaning that all inbound connections will behave asynchronously.

## Data Type

Integer

# Listening Property ([PipeServer](#pipeserver-class) Class)

If True, the class accepts incoming connections.

## Syntax

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

Unicode (Windows)
BOOL GetListening();
```

## Default Value

FALSE

## Remarks

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

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

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

## Data Type

Boolean

# PipeName Property ([PipeServer](#pipeserver-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 on which to accept connections. Clients must use this name when establishing a connection to PipeServer.

## Data Type

String

# Config Method ([PipeServer](#pipeserver-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-pipeserver-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-pipeserver-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.

# Disconnect Method ([PipeServer](#pipeserver-class) Class)

This method disconnects the specified client.

## Syntax

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

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

## Remarks

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

## 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 ([PipeServer](#pipeserver-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.)

# Interrupt Method ([PipeServer](#pipeserver-class) Class)

This method interrupts a synchronous send to the remote host.

## Syntax

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

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

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

## 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 ([PipeServer](#pipeserver-class) Class)

This method sends binary data to the specified client.

## Syntax

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

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

## Remarks

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

 When [Timeout](#PipeConnection_f_Timeout) is set to 0, the class 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 error 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-class) event before attempting to send data again.

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

## 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 ([PipeServer](#pipeserver-class) Class)

This method sends binary data to the specified client.

## Syntax

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

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

## Remarks

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

 When [Timeout](#PipeConnection_f_Timeout) is set to 0, the class 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 error 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-class) event before attempting to send data again.

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

## 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 ([PipeServer](#pipeserver-class) Class)

This method sends the file to the remote host.

## Syntax

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

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

## Remarks

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

## 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 ([PipeServer](#pipeserver-class) Class)

This method sends a string followed by a new line.

## Syntax

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

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

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

## 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 ([PipeServer](#pipeserver-class) Class)

This method sends text to the specified client.

## Syntax

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

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

## Remarks

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

 When [Timeout](#PipeConnection_f_Timeout) is set to 0, the class 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 error 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-class) event before attempting to send data again.

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

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

# Shutdown Method ([PipeServer](#pipeserver-class) Class)

This method shuts down the server.

## Syntax

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

Unicode (Windows)
INT Shutdown();
```

## Remarks

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

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

# StartListening Method ([PipeServer](#pipeserver-class) Class)

This method starts listening for incoming connections.

## Syntax

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

Unicode (Windows)
INT StartListening();
```

## Remarks

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

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

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

# StopListening Method ([PipeServer](#pipeserver-class) Class)

This method stops listening for new connections.

## Syntax

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

Unicode (Windows)
INT StopListening();
```

## 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-class) instead.

## 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 ([PipeServer](#pipeserver-class) Class)

Fired immediately after a connection completes.

## Syntax

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

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

## Remarks

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

# DataIn Event ([PipeServer](#pipeserver-class) Class)

This event is fired when data come in.

## Syntax

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

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

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

Fires when a client disconnects.

## Syntax

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

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

## Remarks

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

# Error Event ([PipeServer](#pipeserver-class) Class)

This event fires information about errors during data delivery.

## Syntax

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

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

## Remarks

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

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

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

# ReadyToSend Event ([PipeServer](#pipeserver-class) Class)

Fired when the class is ready to send data.

## Syntax

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

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

## Remarks

The ReadyToSend event indicates that the underlying pipe is ready to accept data after a failed [SendBytes](#sendbytes-method-pipeserver-class). The event is also fired immediately after a connection to the remote host is established.

# PipeConnection Type

A currently connected client.

## Syntax

 *IPWorksIPCPipeConnection* (declared in *ipworksipc.h*)

## Remarks

This type describes the connection of a client which is currently connected to the class. 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** *int (read-only)*
*Default Value: 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 Value: 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 class is operating in the synchronous mode (i.e., the [Timeout](#PipeConnection_f_Timeout) property is set to a positive value).

 **Connected** *int (read-only)*
*Default Value: 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** *int (read-only)*
*Default Value: 0*

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

 **EOL** *char**
*Default Value: ""*

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.

When reading the value of the field, if *ConnectionId* does not belong to a valid connection, then NULL will be returned, and the LastError property will contain a corresponding error message. If no error is encountered, then LastError will contain NULL.

 **MaxLineLength** *int*
*Default Value: 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** *int*
*Default Value: FALSE*

This field shows the special mode for line-oriented protocols. When SingleLineMode is True, the class 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 Value: 0*

This field specifies a timeout for the class.

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 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](#PipeConnection_f_Timeout) seconds.

The class 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 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](#PipeConnection_f_Timeout) field is 0 (asynchronous operation).

## Constructors

```text
PipeConnection()
```

# IPWorksIPCList Type

## Syntax

 *IPWorksIPCList<T>* (declared in *ipworksipc.h*)

## Remarks

 *IPWorksIPCList* is a generic class that is used to hold a collection of objects of type *T*, where *T* is one of the custom types supported by the PipeServer class.

```text
int GetCount() {}
```

```text
int SetCount(int count) {}
```

```text
T* Get(int index) {}
```

```text
T* Set(int index, T* value) {}
```

|  |  |
| --- | --- |
| Methods |  |
| GetCount | This method returns the current size of the collection. |
| SetCount | This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. |
| Get | This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified. |
| Set | This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class. |

# Config Settings ([PipeServer](#pipeserver-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-pipeserver-class) method.

### PipeServer Config Settings

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

**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-pipeserver-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 ([PipeServer](#pipeserver-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.

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