PtConnectionClientSetError()

Set the error-handler function for the client-side of a connection

Synopsis:

PtConnectionClientErrorFunc_t *
    PtConnectionClientSetError(
        PtConnectionClient_t *connection,
        PtConnectionClientErrorFunc_t *func );

Library:

ph

Description:

This function sets up an error handling function for the client-side of a connection. The prototype of the handler is:

typedef int PtConnectionClientErrorFunc_t(
                PtConnectionClient_t *connection,
                int err,
                enum PtConnectionClientError where );

The where argument indicates where the error occurred:

Pt_CONNECTION_SEND_FAILED: The MsgSend() to the server failed.
Pt_CONNECTION_REALLOC_REPLY: The realloc() failed to expand the reply buffer.
Pt_CONNECTION_CLIENT_BROKEN: The server has died or closed its part of the connection.

The error handler is called when certain errors occur; the handler can return Pt_CONTINUE to retry, or Pt_END to fail. The default error handler returns Pt_END.

If your application has created its own channel without _NTO_CHF_COID_DISCONNECT and _NTO_CHF_DISCONNECT set, this mechanism won't work. For more information, see PhChannelAttach().

Returns:

A pointer to the previous error-handler function.

Classification:

Photon

Safety:
Interrupt handler	No
Signal handler	No
Thread	No