PipeClient Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

PipeClient

Remarks

The PipeClient class is used to connect to an existing pipe server. After connecting the transfer of data is handled very similarly to socket communication.

To begin, first set PipeName to the name of the pipe to which the connection will be made. Call Connect or set Connected to True to establish the connection. The Connected event will fire when the connection is complete.

After connecting set DataToSend, or call Send or SendFile to send data. Incoming data is received through the DataIn event.

To disconnect call Disconnect or set Connected to False.

Synchronous and Asynchronous Operation

If the Timeout property is set to 0, the class will behave asynchronously and all operations return immediately, potentially failing with an error if they can't be completed immediately.

If Timeout is set to a positive value, the class will behave synchronously and wait for the operation to complete before returning control.

The class will use DoEvents 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 60 seconds.

Property List

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

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.

AcceptData Property (PipeClient Class)

This property enables or disables data reception (the DataIn event).

Syntax

• C++
• C
• Qt

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

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

int ipworksipc_pipeclient_getacceptdata(void* lpObj);
int ipworksipc_pipeclient_setacceptdata(void* lpObj, int bAcceptData);

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

Default Value

TRUE

Remarks

This property enables or disables data reception (the DataIn event). Setting this property to False, temporarily disables data reception (and the DataIn event). Setting this property to True, reenables data reception.

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

This property is not available at design time.

Data Type

Boolean

BytesSent Property (PipeClient Class)

This property includes the number of bytes actually sent after an assignment to DataToSend .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBytesSent();

Unicode (Windows)
INT GetBytesSent();

int ipworksipc_pipeclient_getbytessent(void* lpObj);

int GetBytesSent();

Default Value

0

Remarks

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

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

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

Data Type

Integer

Connected Property (PipeClient Class)

Triggers a connection or disconnection.

Syntax

• C++
• C
• Qt

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

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

int ipworksipc_pipeclient_getconnected(void* lpObj);
int ipworksipc_pipeclient_setconnected(void* lpObj, int bConnected);

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

Default Value

FALSE

Remarks

This property triggers a connection or disconnection. Setting this property to True makes the class attempt to connect to the host identified by the RemoteHost property. If successful, after the connection is achieved, the value of the property changes to True and the Connected event is fired.

Setting this property to False closes the connection. How and when the connection is closed is controlled by the Linger property.

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

This property triggers a connection or disconnection. Setting this property to True makes the class attempt to connect to the pipe identified by the PipeName property. If successful, after the connection is achieved the value of the property changes to True and the Connected event is fired.

Setting this property to False closes the connection.

This property is not available at design time.

Data Type

Boolean

DataToSend Property (PipeClient Class)

A string of data to be sent over the connected pipe.

Syntax

• C++
• C
• Qt

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

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

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

int SetDataToSend(QByteArray qbaDataToSend);

Default Value

""

Remarks

Assigning a string to this property makes the class send the string to the server. The Send method provides similar functionality.

When Timeout is set to 0 the class will behave asynchronously. If you are sending data to the receiving process faster than it can process it, the outgoing queue might fill up. When this happens, the class fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. The BytesSent 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. (However, please note that ReadyToSend is not fired when part of the data is successfully sent).

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

Data Type

Binary String

EOL Property (PipeClient Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksipc_pipeclient_geteol(void* lpObj, char** lpEOL, int* lenEOL);
int ipworksipc_pipeclient_seteol(void* lpObj, const char* lpEOL, int lenEOL);

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

Default Value

""

Remarks

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

This property is especially useful with ASCII files. Setting it to CRLF ("\r\n") enables the incoming ASCII text stream to split into defined lines. In this case, one event is fired for each line received (as well as in packet boundaries). The CRLF ("\r\n") bytes are discarded.

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

Data Type

Binary String

PipeName Property (PipeClient 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_pipeclient_getpipename(void* lpObj);
int ipworksipc_pipeclient_setpipename(void* lpObj, const char* lpszPipeName);

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

Default Value

""

Remarks

This property specifies the name of the pipe.

This may be the name by itself, for instance "MyPipe", or in the format "\\.\pipe\MyPipe".

Data Type

String

RecordLength Property (PipeClient Class)

The length of received data records.

Syntax

• C++
• C
• Qt

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

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

int ipworksipc_pipeclient_getrecordlength(void* lpObj);
int ipworksipc_pipeclient_setrecordlength(void* lpObj, int iRecordLength);

int GetRecordLength();
int SetRecordLength(int iRecordLength);

Default Value

0

Remarks

If set to a positive value, this property defines the length of data records to be received. The class will accumulate data until RecordLength is reached and only then fire the DataIn event with data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time, including within the DataIn event.

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

This property is not available at design time.

Data Type

Integer

SingleLineMode Property (PipeClient Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksipc_pipeclient_getsinglelinemode(void* lpObj);
int ipworksipc_pipeclient_setsinglelinemode(void* lpObj, int bSingleLineMode);

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

Default Value

FALSE

Remarks

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

When this property is set to True, AcceptData automatically will be set to False. Please refer to the GetLine method for more information.

This property is not available at design time.

Data Type

Boolean

Timeout Property (PipeClient Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

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

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

int ipworksipc_pipeclient_gettimeout(void* lpObj);
int ipworksipc_pipeclient_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

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

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

The class will use DoEvents 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 60 seconds.

Data Type

Integer

Config Method (PipeClient 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_pipeclient_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.

Connect Method (PipeClient Class)

Connects to a named pipe.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworksipc_pipeclient_connect(void* lpObj);

int Connect();

Remarks

This method connects to a named pipe specified by PipeName. Calling this method is equivalent to setting the Connected property to True.

Example (Connecting)

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

Error Handling (C++)

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

Disconnect Method (PipeClient Class)

Disconnects from the named pipe.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworksipc_pipeclient_disconnect(void* lpObj);

int Disconnect();

Remarks

This method disconnects from the pipe. Calling this method is equivalent to setting the Connected property to False.

Error Handling (C++)

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

DoEvents Method (PipeClient Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

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

GetLine Method (PipeClient Class)

This method gets a line of text from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLine();

Unicode (Windows)
LPWSTR GetLine();

char* ipworksipc_pipeclient_getline(void* lpObj);

QString GetLine();

Remarks

This method gets a line of text from the server. This method is an alternative method of receiving data for line-oriented protocols. The class will block if necessary and then will return the received line. AcceptData will be set automatically to True when the method is called, and then will be set to False after a line is received.

Please refer to the SingleLineMode property for more information.

Error Handling (C++)

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

Interrupt Method (PipeClient Class)

This method interrupts the current action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworksipc_pipeclient_interrupt(void* lpObj);

int Interrupt();

Remarks

This method interrupts the current action. If you use SendFile to upload a file, the class will run synchronously until the upload is completed. This method will allow you to stop the file from uploading without disconnecting from the host.

Error Handling (C++)

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

Send Method (PipeClient Class)

Sends data over the connected pipe.

Syntax

• C++
• C
• Qt

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

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

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

int Send(QByteArray qbaText);

Remarks

This method sends data to the server. Calling this method is equivalent to setting the DataToSend property to Text.

Error Handling (C++)

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

SendBytes Method (PipeClient Class)

This method sends binary data over the connected pipe.

Syntax

• C++
• C
• Qt

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

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

int ipworksipc_pipeclient_sendbytes(void* lpObj, const char* lpData, int lenData);

int SendBytes(QByteArray qbaData);

Remarks

This method sends the specified binary data to the server. 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 receiving process faster than it can process it, the outgoing queue might fill up. When this happens, the class fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. The BytesSent 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. (However, please note that ReadyToSend is not fired when part of the data is successfully sent).

Error Handling (C++)

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

SendFile Method (PipeClient Class)

Sends the file over the connected pipe.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT SendFile(LPCWSTR lpszFileName);

int ipworksipc_pipeclient_sendfile(void* lpObj, const char* lpszFileName);

int SendFile(const QString& qsFileName);

Remarks

This method sends the specified file to the server/process over the connected pipe.

Timeout must be set to a positive value so that the class will operate synchronously.

Error Handling (C++)

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

SendLine Method (PipeClient Class)

This method sends a string followed by a newline.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT SendLine(LPCWSTR lpszText);

int ipworksipc_pipeclient_sendline(void* lpObj, const char* lpszText);

int SendLine(const QString& qsText);

Remarks

This method sends a string followed by a newline. This method is used to send data with line-oriented protocols. The line is followed by CRLF ("\r\n") .

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

Error Handling (C++)

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

SendText Method (PipeClient Class)

This method sends text over the connected pipe.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT SendText(LPCWSTR lpszText);

int ipworksipc_pipeclient_sendtext(void* lpObj, const char* lpszText);

int SendText(const QString& qsText);

Remarks

This method sends the specified text to the server. To send binary data, use the SendBytes method instead.

When Timeout is set to 0 the class will behave asynchronously. If you are sending data to the receiving process faster than it can process it, the outgoing queue might fill up. When this happens, the class fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. The BytesSent 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. (However, please note that ReadyToSend is not fired when part of the data is successfully sent).

Error Handling (C++)

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

Connected Event (PipeClient Class)

Fired immediately after a connection completes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(PipeClientConnectedEventParams *e);

typedef struct {
  int reserved;
} PipeClientConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(PipeClientConnectedEventParams *e);

typedef struct {
  INT reserved;
} PipeClientConnectedEventParams;

#define EID_PIPECLIENT_CONNECTED 1

virtual INT IPWORKSIPC_CALL FireConnected();

class PipeClientConnectedEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

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

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

Remarks

When the connection is successfully established this event will fire.

DataIn Event (PipeClient Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDataIn(PipeClientDataInEventParams *e);

typedef struct {
  const char *Text;
  int lenText;
  int EOL;
  int reserved;
} PipeClientDataInEventParams;


Unicode (Windows)
virtual INT FireDataIn(PipeClientDataInEventParams *e);

typedef struct {
  LPCSTR Text;
  INT lenText;
  BOOL EOL;
  INT reserved;
} PipeClientDataInEventParams;

#define EID_PIPECLIENT_DATAIN 2

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

class PipeClientDataInEventParams {
public:
  const QByteArray &Text();

  bool EOL();

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

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

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

Remarks

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

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

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

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

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

Disconnected Event (PipeClient Class)

Fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(PipeClientDisconnectedEventParams *e);

typedef struct {
  int reserved;
} PipeClientDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(PipeClientDisconnectedEventParams *e);

typedef struct {
  INT reserved;
} PipeClientDisconnectedEventParams;

#define EID_PIPECLIENT_DISCONNECTED 3

virtual INT IPWORKSIPC_CALL FireDisconnected();

class PipeClientDisconnectedEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

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

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

Remarks

When the connection is closed this event will fire.

Error Event (PipeClient Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(PipeClientErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} PipeClientErrorEventParams;


Unicode (Windows)
virtual INT FireError(PipeClientErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} PipeClientErrorEventParams;

#define EID_PIPECLIENT_ERROR 4

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

class PipeClientErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

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

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

ReadyToSend Event (PipeClient Class)

Fired when the class is ready to send data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireReadyToSend(PipeClientReadyToSendEventParams *e);

typedef struct {
  int reserved;
} PipeClientReadyToSendEventParams;


Unicode (Windows)
virtual INT FireReadyToSend(PipeClientReadyToSendEventParams *e);

typedef struct {
  INT reserved;
} PipeClientReadyToSendEventParams;

#define EID_PIPECLIENT_READYTOSEND 5

virtual INT IPWORKSIPC_CALL FireReadyToSend();

class PipeClientReadyToSendEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

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

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

Remarks

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

Config Settings (PipeClient Class)

PipeClient Config Settings

Base Config Settings

Trappable Errors (PipeClient Class)

Error Handling (C++)

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

PipeClient Errors