ConnectionStatus Event

Fired to indicate changes in connection state.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
virtual int FireConnectionStatus(OAuthConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} OAuthConnectionStatusEventParams;

Unicode (Windows)
virtual INT FireConnectionStatus(OAuthConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} OAuthConnectionStatusEventParams;

- (void)onConnectionStatus:(NSString*)connectionEvent :(int)statusCode :(NSString*)description;

#define EID_OAUTH_CONNECTIONSTATUS 2

virtual INT CLOUDMAIL_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

Remarks

The ConnectionStatus event is fired when the connection state changes: completion of a firewall or proxy connection, completion of a security handshake, etc.

The ConnectionEvent parameter indicates the type of connection event. Values may include:

StatusCode has the error code returned by the TCP/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.