PipeServer Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TiipPipeServer

Remarks

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

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

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

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

Property List


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

ConnectionsA collection of currently connected clients.
DefaultEOLThis property includes a default end-of-line (EOL) value to be used by incoming connections.
DefaultMaxLineLengthThe property includes the default maximum line length value for inbound connections.
DefaultSingleLineModeThis property tells the component whether or not to treat new connections as line oriented.
DefaultTimeoutThis property includes an initial timeout value to be used by incoming connections.
ListeningIf True, the component accepts incoming connections.
PipeNameThe name of the pipe.

Method List


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

ConfigSets or retrieves a configuration setting.
DisconnectThis method disconnects the specified client.
DoEventsProcesses events from the internal message queue.
InterruptThis method interrupts a synchronous send to the remote host.
SendThis method sends binary data to the specified client.
SendFileThis method sends the file to the remote host.
SendLineThis method sends a string followed by a new line.
ShutdownThis method shuts down the server.
StartListeningThis method starts listening for incoming connections.
StopListeningThis method stops listening for new connections.

Event List


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

ConnectedFired immediately after a connection completes.
DataInThis event is fired when data come in.
DisconnectedFires when a client disconnects.
ErrorThis event fires information about errors during data delivery.
ReadyToSendFired when the component is ready to send data.

Config Settings


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

CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
CustomSecurityDescriptionA custom security descriptor to define access to the pipe.
InBufferSizeThe size in bytes of the output buffer.
OutBufferSizeThe size in bytes of the input buffer.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Connections Property (PipeServer Component)

A collection of currently connected clients.

Syntax

property Connections: TiipPipeConnectionList read get_Connections;

Remarks

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

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

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

This property is read-only.

Please refer to the PipeConnection type for a complete list of fields.

DefaultEOL Property (PipeServer Component)

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

Syntax

property DefaultEOL: String read get_DefaultEOL write set_DefaultEOL;
property DefaultEOLB: TBytes read get_DefaultEOLB write set_DefaultEOLB;

Default Value

''

Remarks

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

DefaultMaxLineLength Property (PipeServer Component)

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

Syntax

property DefaultMaxLineLength: Integer read get_DefaultMaxLineLength write set_DefaultMaxLineLength;

Default Value

2048

Remarks

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

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

DefaultSingleLineMode Property (PipeServer Component)

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

Syntax

property DefaultSingleLineMode: Boolean read get_DefaultSingleLineMode write set_DefaultSingleLineMode;

Default Value

false

Remarks

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

DefaultTimeout Property (PipeServer Component)

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

Syntax

property DefaultTimeout: Integer read get_DefaultTimeout write set_DefaultTimeout;

Default Value

0

Remarks

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

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

Listening Property (PipeServer Component)

If True, the component accepts incoming connections.

Syntax

property Listening: Boolean read get_Listening write set_Listening;

Default Value

false

Remarks

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

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

This property is not available at design time.

PipeName Property (PipeServer Component)

The name of the pipe.

Syntax

property PipeName: String read get_PipeName write set_PipeName;

Default Value

''

Remarks

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

Config Method (PipeServer Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

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

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

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

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

Disconnect Method (PipeServer Component)

This method disconnects the specified client.

Syntax

procedure Disconnect(ConnectionId: Integer);

Remarks

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

DoEvents Method (PipeServer Component)

Processes events from the internal message queue.

Syntax

procedure DoEvents();

Remarks

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

Interrupt Method (PipeServer Component)

This method interrupts a synchronous send to the remote host.

Syntax

procedure Interrupt(ConnectionId: Integer);

Remarks

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

Send Method (PipeServer Component)

This method sends binary data to the specified client.

Syntax

procedure Send(ConnectionId: Integer; Text: TBytes);

Remarks

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

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

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

SendFile Method (PipeServer Component)

This method sends the file to the remote host.

Syntax

procedure SendFile(ConnectionId: Integer; FileName: String);

Remarks

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

SendLine Method (PipeServer Component)

This method sends a string followed by a new line.

Syntax

procedure SendLine(ConnectionId: Integer; Text: String);

Remarks

This method is used to send data with line-oriented protocols. The line is followed by CRLF ('#13#10') .

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

Shutdown Method (PipeServer Component)

This method shuts down the server.

Syntax

procedure Shutdown();

Remarks

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

StartListening Method (PipeServer Component)

This method starts listening for incoming connections.

Syntax

procedure StartListening();

Remarks

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

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

StopListening Method (PipeServer Component)

This method stops listening for new connections.

Syntax

procedure 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 instead.

Connected Event (PipeServer Component)

Fired immediately after a connection completes.

Syntax

type TConnectedEvent = procedure (
  Sender: TObject;
  ConnectionId: Integer
) of Object;

property OnConnected: TConnectedEvent read FOnConnected write FOnConnected;

Remarks

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

DataIn Event (PipeServer Component)

This event is fired when data come in.

Syntax

type TDataInEvent = procedure (
  Sender: TObject;
  ConnectionId: Integer;
  Text: String;
  TextB: TBytes;
  EOL: Boolean
) of Object;

property OnDataIn: TDataInEvent read FOnDataIn write FOnDataIn;

Remarks

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

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

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

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

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

Disconnected Event (PipeServer Component)

Fires when a client disconnects.

Syntax

type TDisconnectedEvent = procedure (
  Sender: TObject;
  ConnectionId: Integer
) of Object;

property OnDisconnected: TDisconnectedEvent read FOnDisconnected write FOnDisconnected;

Remarks

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

Error Event (PipeServer Component)

This event fires information about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ConnectionId: Integer;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

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

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

ConnectionId indicates the connection for which the error is applicable.

ReadyToSend Event (PipeServer Component)

Fired when the component is ready to send data.

Syntax

type TReadyToSendEvent = procedure (
  Sender: TObject;
  ConnectionId: Integer
) of Object;

property OnReadyToSend: TReadyToSendEvent read FOnReadyToSend write FOnReadyToSend;

Remarks

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

PipeConnection Type

A currently connected client.

Remarks

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

Fields

AcceptData
Boolean

Default Value: True

Setting this property to false temporarily disables data reception (and the DataIn event) for the connection. Setting this to true re-enables data reception.

Note: It is recommended to use the PauseData or ProcessData method instead of setting this property.

BytesSent
Integer (read-only)

Default Value: 0

This property shows how many bytes were sent after the last assignment to DataToSend. Please check DataToSend for more information.

Note: This property will always return 0 when the component is operating in the synchronous mode (i.e., the Timeout property is set to a positive value).

Connected
Boolean

Default Value: False

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

The Connected property may be set to false to close the connection.

Connected also shows the status of a particular connection (connected/disconnected).

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

ConnectionId
String (read-only)

Default Value: ""

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

DataToSend
String

Default Value: ""

This property contains a string of data to be sent to the remote host. It is a write-only property.

Assigning a string to the DataToSend makes the component send the string to the remote host. The Send method provides similar functionality.

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

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

Note: It is recommended to use the Send or SendBytes method instead of setting this property.

DataToSendB
TBytes

Default Value: ""

This property contains a string of data to be sent to the remote host. It is a write-only property.

Assigning a string to the DataToSend makes the component send the string to the remote host. The Send method provides similar functionality.

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

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

Note: It is recommended to use the Send or SendBytes method instead of setting this property.

EOL
String

Default Value: ""

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

The EOL property is especially useful with ASCII files. By setting it to CRLF ('#13#10') , 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 ('#13#10') . bytes are discarded.

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

EOLB
TBytes

Default Value: ""

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

The EOL property is especially useful with ASCII files. By setting it to CRLF ('#13#10') , 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 ('#13#10') . bytes are discarded.

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

MaxLineLength
Integer

Default Value: 2048

This property is the size of an internal buffer that holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before 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 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 is 256 bytes. The default value is 2048 bytes.

SingleLineMode
Boolean

Default Value: False

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

Timeout
Integer

Default Value: 0

This property specifies a timeout for the component.

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

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

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

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

Please note that by default, all timeouts are inactivity timeouts, i.e. 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 0 (asynchronous operation).

Constructors

constructor Create();

Config Settings (PipeServer Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

PipeServer Config Settings

CloseStreamAfterTransfer:   If true, the component will close the upload or download stream after the transfer.

This setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. In order to keep streams open after the transfer of data, set this to False. the default value is True.

CustomSecurityDescription:   A custom security descriptor to define access to the pipe.

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

InBufferSize:   The size in bytes of the output buffer.

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

OutBufferSize:   The size in bytes of the input buffer.

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

Base Config Settings

BuildInfo:   Information about the product's build.

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

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:

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

LicenseInfo:   Information about the current license.

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

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

This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to False, the component will use the system security libraries by default to perform cryptographic functions where applicable.

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

This setting is set to False by default on all platforms.

Trappable Errors (PipeServer Component)

PipeServer Errors

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