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

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, 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 class with short descriptions. Click on the links for further details.

Method List

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

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.

Config Settings

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

ConnectionCount Property (PipeServer Class)

The number of records in the arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnectionCount();

Unicode (Windows)
INT GetConnectionCount();

int ipworksipc_pipeserver_getconnectioncount(void* lpObj);

int GetConnectionCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• AcceptData
• BytesSent
• Connected
• ConnectionId
• DataToSend
• EOL
• MaxLineLength
• SingleLineMode
• Timeout

The array indices start at 0 and end at ConnectionCount - 1.

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

Data Type

Integer

AcceptData Property (PipeServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAcceptData(int iConnectionId);
int SetAcceptData(int iConnectionId, int bAcceptData);

Unicode (Windows)
BOOL GetAcceptData(INT iConnectionId);
INT SetAcceptData(INT iConnectionId, BOOL bAcceptData);

int ipworksipc_pipeserver_getacceptdata(void* lpObj, int connectionid);
int ipworksipc_pipeserver_setacceptdata(void* lpObj, int connectionid, int bAcceptData);

bool GetAcceptData(int iConnectionId);
int SetAcceptData(int iConnectionId, bool bAcceptData);

Default Value

TRUE

Remarks

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.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

This property is not available at design time.

Data Type

Boolean

BytesSent Property (PipeServer Class)

This property shows how many bytes were sent after the last assignment to DataToSend .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBytesSent(int iConnectionId);

Unicode (Windows)
INT GetBytesSent(INT iConnectionId);

int ipworksipc_pipeserver_getbytessent(void* lpObj, int connectionid);

int GetBytesSent(int iConnectionId);

Default Value

0

Remarks

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 class is operating in the synchronous mode (i.e., the Timeout property is set to a positive value).

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

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

Data Type

Integer

Connected Property (PipeServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected(int iConnectionId);
int SetConnected(int iConnectionId, int bConnected);

Unicode (Windows)
BOOL GetConnected(INT iConnectionId);
INT SetConnected(INT iConnectionId, BOOL bConnected);

int ipworksipc_pipeserver_getconnected(void* lpObj, int connectionid);
int ipworksipc_pipeserver_setconnected(void* lpObj, int connectionid, int bConnected);

bool GetConnected(int iConnectionId);
int SetConnected(int iConnectionId, bool bConnected);

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

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

This property is not available at design time.

Data Type

Boolean

ConnectionId Property (PipeServer Class)

This property contains an identifier generated by the class to identify each connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnectionId(int iConnectionId);

Unicode (Windows)
LPWSTR GetConnectionId(INT iConnectionId);

char* ipworksipc_pipeserver_getconnectionid(void* lpObj, int connectionid);

QString GetConnectionId(int iConnectionId);

Default Value

""

Remarks

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

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

Data Type

String

DataToSend Property (PipeServer Class)

This property contains a string of data to be sent to the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetDataToSend(int iConnectionId, const char* lpDataToSend, int lenDataToSend);

Unicode (Windows)
INT SetDataToSend(INT iConnectionId, LPCSTR lpDataToSend, INT lenDataToSend);

int ipworksipc_pipeserver_setdatatosend(void* lpObj, int connectionid, const char* lpDataToSend, int lenDataToSend);

int SetDataToSend(int iConnectionId, QByteArray qbaDataToSend);

Default Value

""

Remarks

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 class send the string to the remote host. The Send method provides similar functionality.

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

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

Data Type

Binary String

EOL Property (PipeServer Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksipc_pipeserver_geteol(void* lpObj, int connectionid, char** lpEOL, int* lenEOL);
int ipworksipc_pipeserver_seteol(void* lpObj, int connectionid, const char* lpEOL, int lenEOL);

QByteArray GetEOL(int iConnectionId);
int SetEOL(int iConnectionId, QByteArray qbaEOL);

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 ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

This property is not available at design time.

Data Type

Binary String

MaxLineLength Property (PipeServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMaxLineLength(int iConnectionId);
int SetMaxLineLength(int iConnectionId, int iMaxLineLength);

Unicode (Windows)
INT GetMaxLineLength(INT iConnectionId);
INT SetMaxLineLength(INT iConnectionId, INT iMaxLineLength);

int ipworksipc_pipeserver_getmaxlinelength(void* lpObj, int connectionid);
int ipworksipc_pipeserver_setmaxlinelength(void* lpObj, int connectionid, int iMaxLineLength);

int GetMaxLineLength(int iConnectionId);
int SetMaxLineLength(int iConnectionId, int iMaxLineLength);

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

This property is not available at design time.

Data Type

Integer

SingleLineMode Property (PipeServer Class)

This property shows the special mode for line-oriented protocols.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSingleLineMode(int iConnectionId);
int SetSingleLineMode(int iConnectionId, int bSingleLineMode);

Unicode (Windows)
BOOL GetSingleLineMode(INT iConnectionId);
INT SetSingleLineMode(INT iConnectionId, BOOL bSingleLineMode);

int ipworksipc_pipeserver_getsinglelinemode(void* lpObj, int connectionid);
int ipworksipc_pipeserver_setsinglelinemode(void* lpObj, int connectionid, int bSingleLineMode);

bool GetSingleLineMode(int iConnectionId);
int SetSingleLineMode(int iConnectionId, bool bSingleLineMode);

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 ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

This property is not available at design time.

Data Type

Boolean

Timeout Property (PipeServer Class)

This property specifies a timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout(int iConnectionId);
int SetTimeout(int iConnectionId, int iTimeout);

Unicode (Windows)
INT GetTimeout(INT iConnectionId);
INT SetTimeout(INT iConnectionId, INT iTimeout);

int ipworksipc_pipeserver_gettimeout(void* lpObj, int connectionid);
int ipworksipc_pipeserver_settimeout(void* lpObj, int connectionid, int iTimeout);

int GetTimeout(int iConnectionId);
int SetTimeout(int iConnectionId, int iTimeout);

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.

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

This property is not available at design time.

Data Type

Integer

DefaultEOL Property (PipeServer Class)

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

Syntax

• C++
• C
• Qt

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);

int ipworksipc_pipeserver_getdefaulteol(void* lpObj, char** lpDefaultEOL, int* lenDefaultEOL);
int ipworksipc_pipeserver_setdefaulteol(void* lpObj, const char* lpDefaultEOL, int lenDefaultEOL);

QByteArray GetDefaultEOL();
int SetDefaultEOL(QByteArray qbaDefaultEOL);

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

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

Syntax

• C++
• C
• Qt

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

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

int ipworksipc_pipeserver_getdefaultmaxlinelength(void* lpObj);
int ipworksipc_pipeserver_setdefaultmaxlinelength(void* lpObj, int iDefaultMaxLineLength);

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

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

Syntax

• C++
• C
• Qt

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

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

int ipworksipc_pipeserver_getdefaultsinglelinemode(void* lpObj);
int ipworksipc_pipeserver_setdefaultsinglelinemode(void* lpObj, int bDefaultSingleLineMode);

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

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

Syntax

• C++
• C
• Qt

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

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

int ipworksipc_pipeserver_getdefaulttimeout(void* lpObj);
int ipworksipc_pipeserver_setdefaulttimeout(void* lpObj, int iDefaultTimeout);

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

If True, the class accepts incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetListening();
int SetListening(int bListening);

Unicode (Windows)
BOOL GetListening();
INT SetListening(BOOL bListening);

int ipworksipc_pipeserver_getlistening(void* lpObj);
int ipworksipc_pipeserver_setlistening(void* lpObj, int bListening);

bool GetListening();
int SetListening(bool bListening);

Default Value

FALSE

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

PipeName Property (PipeServer Class)

The name of the pipe.

Syntax

• C++
• C
• Qt

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

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

char* ipworksipc_pipeserver_getpipename(void* lpObj);
int ipworksipc_pipeserver_setpipename(void* lpObj, const char* lpszPipeName);

QString GetPipeName();
int SetPipeName(QString qsPipeName);

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

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksipc_pipeserver_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

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

This method disconnects the specified client.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT Disconnect(INT iConnectionId);

int ipworksipc_pipeserver_disconnect(void* lpObj, int iConnectionId);

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

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksipc_pipeserver_doevents(void* lpObj);

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

This method interrupts a synchronous send to the remote host.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT Interrupt(INT iConnectionId);

int ipworksipc_pipeserver_interrupt(void* lpObj, int iConnectionId);

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

This method sends binary data to the specified client.

Syntax

• C++
• C
• Qt

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

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

int ipworksipc_pipeserver_send(void* lpObj, int iConnectionId, const char* lpText, int lenText);

int Send(int iConnectionId, QByteArray qbaText);

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 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 event before attempting to send data again.

Note: The ReadyToSend 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 Class)

This method sends the file to the remote host.

Syntax

• C++
• C
• Qt

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

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

int ipworksipc_pipeserver_sendfile(void* lpObj, int iConnectionId, const char* lpszFileName);

int SendFile(int iConnectionId, const QString& qsFileName);

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

This method sends a string followed by a new line.

Syntax

• C++
• C
• Qt

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

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

int ipworksipc_pipeserver_sendline(void* lpObj, int iConnectionId, const char* lpszText);

int SendLine(int iConnectionId, const QString& qsText);

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

Shutdown Method (PipeServer Class)

This method shuts down the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Shutdown();

Unicode (Windows)
INT Shutdown();

int ipworksipc_pipeserver_shutdown(void* lpObj);

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

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

This method starts listening for incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartListening();

Unicode (Windows)
INT StartListening();

int ipworksipc_pipeserver_startlistening(void* lpObj);

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

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

This method stops listening for new connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StopListening();

Unicode (Windows)
INT StopListening();

int ipworksipc_pipeserver_stoplistening(void* lpObj);

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

Fired immediately after a connection completes.

Syntax

• C++
• C
• Qt

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;

#define EID_PIPESERVER_CONNECTED 1

virtual INT IPWORKSIPC_CALL FireConnected(INT &iConnectionId);

class PipeServerConnectedEventParams {
public:
  int ConnectionId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(PipeServerConnectedEventParams *e);

// Or, subclass PipeServer and override this emitter function.
virtual int FireConnected(PipeServerConnectedEventParams *e) {...}

Remarks

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

DataIn Event (PipeServer Class)

This event is fired when data come in.

Syntax

• C++
• C
• Qt

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;

#define EID_PIPESERVER_DATAIN 2

virtual INT IPWORKSIPC_CALL FireDataIn(INT &iConnectionId, LPSTR &lpText, INT &lenText, BOOL &bEOL);

class PipeServerDataInEventParams {
public:
  int ConnectionId();

  const QByteArray &Text();

  bool EOL();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DataIn(PipeServerDataInEventParams *e);

// Or, subclass PipeServer and override this emitter function.
virtual int FireDataIn(PipeServerDataInEventParams *e) {...}

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

Fires when a client disconnects.

Syntax

• C++
• C
• Qt

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;

#define EID_PIPESERVER_DISCONNECTED 3

virtual INT IPWORKSIPC_CALL FireDisconnected(INT &iConnectionId);

class PipeServerDisconnectedEventParams {
public:
  int ConnectionId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(PipeServerDisconnectedEventParams *e);

// Or, subclass PipeServer and override this emitter function.
virtual int FireDisconnected(PipeServerDisconnectedEventParams *e) {...}

Remarks

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

Error Event (PipeServer Class)

This event fires information about errors during data delivery.

Syntax

• C++
• C
• Qt

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;

#define EID_PIPESERVER_ERROR 4

virtual INT IPWORKSIPC_CALL FireError(INT &iConnectionId, INT &iErrorCode, LPSTR &lpszDescription);

class PipeServerErrorEventParams {
public:
  int ConnectionId();

  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(PipeServerErrorEventParams *e);

// Or, subclass PipeServer and override this emitter function.
virtual int FireError(PipeServerErrorEventParams *e) {...}

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

ConnectionId indicates the connection for which the error is applicable.

ReadyToSend Event (PipeServer Class)

Fired when the class is ready to send data.

Syntax

• C++
• C
• Qt

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;

#define EID_PIPESERVER_READYTOSEND 5

virtual INT IPWORKSIPC_CALL FireReadyToSend(INT &iConnectionId);

class PipeServerReadyToSendEventParams {
public:
  int ConnectionId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ReadyToSend(PipeServerReadyToSendEventParams *e);

// Or, subclass PipeServer and override this emitter function.
virtual int FireReadyToSend(PipeServerReadyToSendEventParams *e) {...}

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.

Config Settings (PipeServer Class)

PipeServer Config Settings

Base Config Settings

Trappable Errors (PipeServer 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