PipeServer Class
Properties Methods Events Config Settings Errors
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
class ipworksipc.PipeServer
Remarks
PipeServer is the server complement of PipeClient (which is used to create client applications). They share a common design philosophy and interface. PipeServer is as easy to use as PipeClient.
The client connections are identified by a ConnectionId, an id generated by the component to identify each connection. This id is unique to each connection. PipeServer's events also have ConnectionId as a parameter to identify the connection to which they are related.
Our main goal in designing PipeServer was to make it easy to use without sacrificing performance. The class has a minimum of properties, and events: on_connected, on_data_in, on_disconnected, on_ready_to_send, and on_error.
PipeServer can start to listen on a pipe by setting pipe_name and then setting listening to True. When a client connects the on_connected 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.
connection_count | The number of records in the arrays. |
accept_data | This property indicates whether data reception is currently enabled. |
bytes_sent | This property shows how many bytes were sent after calling Send or SendBytes . |
connected | This property is used to disconnect individual connections and/or show their status. |
connection_id | This property contains an identifier generated by the class to identify each connection. |
eol | The EOL property is used to define boundaries in the input stream using the value of the property. |
max_line_length | This property is the size of an internal buffer that holds received data while waiting for an EOL string. |
single_line_mode | This property shows the special mode for line-oriented protocols. |
timeout | This property specifies a timeout for the class. |
default_eol | This property includes a default end-of-line (EOL) value to be used by incoming connections. |
default_max_line_length | The property includes the default maximum line length value for inbound connections. |
default_single_line_mode | This property tells the class whether or not to treat new connections as line oriented. |
default_timeout | This property includes an initial timeout value to be used by incoming connections. |
listening | If True, the class accepts incoming connections. |
pipe_name | 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 | Sets or retrieves a configuration setting. |
disconnect | This method disconnects the specified client. |
do_events | This method processes events from the internal message queue. |
interrupt | This method interrupts a synchronous send to the remote host. |
send | This method sends binary data to the specified client. |
send_bytes | This method sends binary data to the specified client. |
send_file | This method sends the file to the remote host. |
send_line | This method sends a string followed by a new line. |
send_text | This method sends text to the specified client. |
shutdown | This method shuts down the server. |
start_listening | This method starts listening for incoming connections. |
stop_listening | 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.
on_connected | Fired immediately after a connection completes. |
on_data_in | This event is fired when data come in. |
on_disconnected | Fires when a client disconnects. |
on_error | This event fires information about errors during data delivery. |
on_ready_to_send | 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 | A custom security descriptor to define access to the pipe. |
InBufferSize | The size in bytes of the output buffer. |
OutBufferSize | The size in bytes of the input buffer. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
connection_count Property
The number of records in the arrays.
Syntax
def get_connection_count() -> int: ...
connection_count = property(get_connection_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at connection_count - 1.This property is read-only.
accept_data Property
This property indicates whether data reception is currently enabled.
Syntax
def get_accept_data(connection_id: int) -> bool: ...
Default Value
TRUE
Remarks
This property indicates whether data reception is currently enabled. When False, data reception is disabled and the ondatain event will not fire for the connection. Use the pausedata and processdata methods to pause and resume data reception.
The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the connection_count property.
This property is read-only.
bytes_sent Property
This property shows how many bytes were sent after calling Send or SendBytes .
Syntax
def get_bytes_sent(connection_id: int) -> int: ...
Default Value
0
Remarks
This property shows how many bytes were sent after calling send or sendbytes. Please see send or sendbytes for more information.
Note: This property will always return 0 when the class is operating in the synchronous mode (i.e., the timeout property is set to a positive value).
The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the connection_count property.
This property is read-only.
connected Property
This property is used to disconnect individual connections and/or show their status.
Syntax
def get_connected(connection_id: int) -> bool: ... def set_connected(connection_id: int, value: bool) -> None: ...
Default Value
FALSE
Remarks
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).
Use the connect and disconnect methods to manage the connection.
The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the connection_count property.
connection_id Property
This property contains an identifier generated by the class to identify each connection.
Syntax
def get_connection_id(connection_id: int) -> int: ...
Default Value
0
Remarks
This property contains an identifier generated by the class to identify each connection. This identifier is unique to this connection.
The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the connection_count property.
This property is read-only.
eol Property
The EOL property is used to define boundaries in the input stream using the value of the property.
Syntax
def get_eol(connection_id: int) -> bytes: ... def set_eol(connection_id: int, value: bytes) -> None: ...
Default Value
""
Remarks
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 ("\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 property 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 property, 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.
The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the connection_count property.
max_line_length Property
This property is the size of an internal buffer that holds received data while waiting for an EOL string.
Syntax
def get_max_line_length(connection_id: int) -> int: ... def set_max_line_length(connection_id: int, value: int) -> None: ...
Default Value
2048
Remarks
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 ondatain 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 ondatain 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.
The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the connection_count property.
single_line_mode Property
This property shows the special mode for line-oriented protocols.
Syntax
def get_single_line_mode(connection_id: int) -> bool: ... def set_single_line_mode(connection_id: int, value: bool) -> None: ...
Default Value
FALSE
Remarks
This property 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.
The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the connection_count property.
timeout Property
This property specifies a timeout for the class.
Syntax
def get_timeout(connection_id: int) -> int: ... def set_timeout(connection_id: int, value: int) -> None: ...
Default Value
0
Remarks
This property specifies a timeout for the class.
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 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 0 (asynchronous operation).
The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the connection_count property.
default_eol Property
This property includes a default end-of-line (EOL) value to be used by incoming connections.
Syntax
def get_default_eol() -> bytes: ... def set_default_eol(value: bytes) -> None: ...
default_eol = property(get_default_eol, set_default_eol)
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.
default_max_line_length Property
The property includes the default maximum line length value for inbound connections.
Syntax
def get_default_max_line_length() -> int: ... def set_default_max_line_length(value: int) -> None: ...
default_max_line_length = property(get_default_max_line_length, set_default_max_line_length)
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.
default_single_line_mode Property
This property tells the class whether or not to treat new connections as line oriented.
Syntax
def get_default_single_line_mode() -> bool: ... def set_default_single_line_mode(value: bool) -> None: ...
default_single_line_mode = property(get_default_single_line_mode, set_default_single_line_mode)
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).
default_timeout Property
This property includes an initial timeout value to be used by incoming connections.
Syntax
def get_default_timeout() -> int: ... def set_default_timeout(value: int) -> None: ...
default_timeout = property(get_default_timeout, set_default_timeout)
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.
listening Property
If True, the class accepts incoming connections.
Syntax
def get_listening() -> bool: ... def set_listening(value: bool) -> None: ...
listening = property(get_listening, set_listening)
Default Value
FALSE
Remarks
Use this property to make the class 'listen' (accept connections) on the pipe specified by pipe_name. Setting this property to False will make the class stop listening. Please note that this does not close any existing connections.
Use the start_listening and stop_listening methods to control whether the class is listening.
pipe_name Property
The name of the pipe.
Syntax
def get_pipe_name() -> str: ... def set_pipe_name(value: str) -> None: ...
pipe_name = property(get_pipe_name, set_pipe_name)
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
Sets or retrieves a configuration setting.
Syntax
def config(configuration_string: str) -> str: ...
Remarks
config is a generic method available in every class. It is used to set and retrieve configuration settings 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, you must call Config("PROPERTY"). The value will be returned as a string.
disconnect Method
This method disconnects the specified client.
Syntax
def disconnect(connection_id: int) -> None: ...
Remarks
Calling this method will disconnect the client specified by the ConnectionId parameter.
do_events Method
This method processes events from the internal message queue.
Syntax
def do_events() -> None: ...
Remarks
When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
interrupt Method
This method interrupts a synchronous send to the remote host.
Syntax
def interrupt(connection_id: int) -> None: ...
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 send_file to upload a file, the class will run synchronously on that Connection Id until it is completed.
send Method
This method sends binary data to the specified client.
Syntax
def send(connection_id: int, text: bytes) -> None: ...
Remarks
This method sends binary data to the client identified by ConnectionId. To send text, use the send_text method instead.
When 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 bytes_sent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the on_ready_to_send event before attempting to send data again.
Note: The on_ready_to_send event is not fired when part of the data is sent successfully.
send_bytes Method
This method sends binary data to the specified client.
Syntax
def send_bytes(connection_id: int, data: bytes) -> None: ...
Remarks
This method sends binary data to the client identified by ConnectionId. To send text, use the send_text method instead.
When 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 bytes_sent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the on_ready_to_send event before attempting to send data again.
Note: The on_ready_to_send event is not fired when part of the data is sent successfully.
send_file Method
This method sends the file to the remote host.
Syntax
def send_file(connection_id: int, file_name: str) -> None: ...
Remarks
This method sends the file to the client specified by the ConnectionId.
send_line Method
This method sends a string followed by a new line.
Syntax
def send_line(connection_id: int, text: str) -> None: ...
Remarks
This method is used to send data with line-oriented protocols. The line is followed by CRLF ("\r\n") .
Please refer to the get_line method and single_line_mode property for more information.
send_text Method
This method sends text to the specified client.
Syntax
def send_text(connection_id: int, text: str) -> None: ...
Remarks
This method sends text to the client identified by ConnectionId. To send binary data, use the send_bytes method instead.
When 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 bytes_sent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the on_ready_to_send event before attempting to send data again.
Note: The on_ready_to_send event is not fired when part of the data is sent successfully.
shutdown Method
This method shuts down the server.
Syntax
def shutdown() -> None: ...
Remarks
This method shuts down the server. Calling this method is equivalent to calling stop_listening and then breaking every client connection by calling disconnect.
start_listening Method
This method starts listening for incoming connections.
Syntax
def start_listening() -> None: ...
Remarks
This method begins listening for incoming connections on the pipe specified by pipe_name.
To stop listening for new connections, call stop_listening. To stop listening for new connections and to disconnect all existing clients, call shutdown.
stop_listening Method
This method stops listening for new connections.
Syntax
def stop_listening() -> None: ...
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.
on_connected Event
Fired immediately after a connection completes.
Syntax
class PipeServerConnectedEventParams(object): @property def connection_id() -> int: ... # In class PipeServer: @property def on_connected() -> Callable[[PipeServerConnectedEventParams], None]: ... @on_connected.setter def on_connected(event_hook: Callable[[PipeServerConnectedEventParams], None]) -> None: ...
Remarks
This event fires immediately after a client connects. The ConnectionId parameter identifies the client connection.
on_data_in Event
This event is fired when data come in.
Syntax
class PipeServerDataInEventParams(object): @property def connection_id() -> int: ... @property def text() -> bytes: ... @property def eol() -> bool: ... # In class PipeServer: @property def on_data_in() -> Callable[[PipeServerDataInEventParams], None]: ... @on_data_in.setter def on_data_in(event_hook: Callable[[PipeServerDataInEventParams], None]) -> None: ...
Remarks
Trapping the on_data_in 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 default_max_line_length or with no eol strings in it, then EOL is False. Please note that this means that one or more on_data_in 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.
on_disconnected Event
Fires when a client disconnects.
Syntax
class PipeServerDisconnectedEventParams(object): @property def connection_id() -> int: ... # In class PipeServer: @property def on_disconnected() -> Callable[[PipeServerDisconnectedEventParams], None]: ... @on_disconnected.setter def on_disconnected(event_hook: Callable[[PipeServerDisconnectedEventParams], None]) -> None: ...
Remarks
This event fires when a client disconnects. The ConnectionId parameters identifies the client that is disconnected.
on_error Event
This event fires information about errors during data delivery.
Syntax
class PipeServerErrorEventParams(object): @property def connection_id() -> int: ... @property def error_code() -> int: ... @property def description() -> str: ... # In class PipeServer: @property def on_error() -> Callable[[PipeServerErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[PipeServerErrorEventParams], None]) -> None: ...
Remarks
The on_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 section.
ConnectionId indicates the connection for which the error is applicable.
on_ready_to_send Event
Fired when the class is ready to send data.
Syntax
class PipeServerReadyToSendEventParams(object): @property def connection_id() -> int: ... # In class PipeServer: @property def on_ready_to_send() -> Callable[[PipeServerReadyToSendEventParams], None]: ... @on_ready_to_send.setter def on_ready_to_send(event_hook: Callable[[PipeServerReadyToSendEventParams], None]) -> None: ...
Remarks
The on_ready_to_send event indicates that the underlying pipe is ready to accept data after a failed send_bytes. The event is also fired immediately after a connection to the remote host is established.
PipeServer Config Settings
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 method.PipeServer Config Settings
Base Config Settings
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 |
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 |
- 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.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
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 section.
PipeServer Errors
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. |