Serial Framework C++ Edition
Classes | Typedefs | Enumerations | Variables
wclCommunication Namespace Reference

Classes

class  CwclClientConnection
 The base class for all client oriented connections. More...
 
class  CwclClientDataConnection
 The base class for the client connection that requires data exchange with a remote device. More...
 
class  CwclCustomClientDataProcessor
 The base class for all WCL Client Data Processors. More...
 
class  CwclCustomConnection
 The base class for all WCL connections. More...
 
class  CwclCustomDataProcessor
 The base class for all WCL Data Processors. More...
 
class  CwclCustomObexClient
 The base class for OBEX client data processors. More...
 
class  CwclCustomObexServer
 The base class for OBEX server data processors. More...
 
class  CwclCustomServerClientDataProcessor
 The base class for all WCL Server Client Data Processors. More...
 
class  CwclObexFileClient
 The base class for OBEX file based clients: OPP, FTP, etc. More...
 
class  CwclObexFtpClient
 The data processor implements the OBEX File Transfer Profile client. More...
 
class  CwclObexOppClient
 The data processor implements the OBEX Object Push Profile client. More...
 
class  CwclObexOppServer
 The data processor implements the OBEX Object Push Profile server. More...
 
class  CwclServerClientConnection
 The base class for all server client connection. More...
 
class  CwclServerClientDataConnection
 The base class for the server client connection that requires data exchange with a remote device. More...
 
class  CwclServerConnection
 The base class for all server connections. More...
 
class  CwclServerDataConnection
 The base class for the server connection that requires data exchange with a remote device. More...
 
class  wclEClientActive
 The exception raises when an application tries to change any property of already active (connecting or connected) client component. More...
 
class  wclEClientConnection
 Exception class used for client connections. More...
 
class  wclEConnection
 The base class for connections exceptions. More...
 
class  wclEServerActive
 The exception raises when an application tries to change any property of already active (listening) server component. More...
 
class  wclEServerClientConnection
 Exception class used for server client connections. More...
 
class  wclEServerConnection
 Exception class used for server connections. More...
 
struct  wclObexFileObject
 The record describes the OBEX file system object. More...
 

Typedefs

typedef std::set< wclObexFilePermissionwclObexFilePermissions
 The OBEX file object permissions. More...
 
typedef std::list< wclObexFileObjectwclObexFileObjects
 Array of file system objects. More...
 

Enumerations

enum  wclClientState {
  csDisconnected, csPreparing, csConnecting, csConnected,
  csDisconnecting
}
 The client connection states. More...
 
enum  wclServerState { ssClosed, ssPreparing, ssListening, ssClosing }
 The server connections states. More...
 
enum  wclObexFilePermission { opRead, opWrite, opDelete }
 The OBEX file object permission. More...
 
enum  wclObexServerOperationResult {
  orSuccess, orForbidden, orObjectNotFound, orUnsupportedMedia,
  orAccessDenied, orUnexpected
}
 The possible OBEX server operation results that can be returned to the client. More...
 

Variables

const int WCL_E_CONNECTION_BASE = 0x00030000
 The base error code for all connection errors. More...
 
const int WCL_E_CONNECTION_ACTIVE = WCL_E_CONNECTION_BASE + 0x0000
 A connection is active. More...
 
const int WCL_E_CONNECTION_NOT_ACTIVE = WCL_E_CONNECTION_BASE + 0x0001
 A connection is not active. More...
 
const int WCL_E_CONNECTION_UNABLE_CREATE_TERMINATE_EVENT = WCL_E_CONNECTION_BASE + 0x0002
 Unable to create communication termination event object. More...
 
const int WCL_E_CONNECTION_UNABLE_CREATE_CONNECTION_COMPLETE_EVENT = WCL_E_CONNECTION_BASE + 0x0003
 Unable to create connection complete event object. More...
 
const int WCL_E_CONNECTION_UNABLE_START_COMMUNICATION = WCL_E_CONNECTION_BASE + 0x0004
 Unable to create communication thread. More...
 
const int WCL_E_CONNECTION_TERMINATED = WCL_E_CONNECTION_BASE + 0x0005
 The connection has been terminated by unknown reason. More...
 
const int WCL_E_CONNECTION_TERMINATED_BY_USER = WCL_E_CONNECTION_BASE + 0x0006
 The connection has been terminated by user. More...
 
const int WCL_E_CONNECTION_UNABLE_CREATE_INIT_EVENT = WCL_E_CONNECTION_BASE + 0x0007
 Unable to create a communication thread initialization event. More...
 
const int WCL_E_CONNECTION_CLOSED = WCL_E_CONNECTION_BASE + 0x0008
 The connection has been closed. More...
 
const int WCL_E_CONNECTION_UNEXPECTED = WCL_E_CONNECTION_BASE + 0x0009
 Unexpected error. More...
 
const int WCL_E_CONNECTION_UNABLE_CREATE_OR_INIT_CLIENT = WCL_E_CONNECTION_BASE + 0x000A
 A server was not able to create or init client connection instance. More...
 
const int WCL_E_CONNECTION_UNABLE_FIND_CLIENT_CLASS = WCL_E_CONNECTION_BASE + 0x000B
 A server was not able to find a specific client connection class. More...
 
const int WCL_E_OBEX_BASE = WCL_E_CONNECTION_BASE + 0x1000
 The base error code for OBEX errors. More...
 
const int WCL_E_OBEX_NOT_CONNECTED = WCL_E_OBEX_BASE + 0x0000
 An OBEX client is not connected to an OBEX server. More...
 
const int WCL_E_OBEX_CONNECTED = WCL_E_OBEX_BASE + 0x0001
 An OBEX client is already connected to an OBEX server. More...
 
const int WCL_E_OBEX_OPERATION_IN_PROGRESS = WCL_E_OBEX_BASE + 0x0002
 An OBEX operation is in progress. More...
 
const int WCL_E_OBEX_CONTINUE = WCL_E_OBEX_BASE + 0x0003
 The server has received the request headers and the client should proceed to send the request body (in the case of a request for which a body needs to be sent). More...
 
const int WCL_E_OBEX_CREATED = WCL_E_OBEX_BASE + 0x0004
 The request has been fulfilled, resulting in the creation of a new resource. More...
 
const int WCL_E_OBEX_ACCEPTED = WCL_E_OBEX_BASE + 0x0005
 The request has been accepted for processing, but the processing has not been completed. The request might or might not be eventually acted upon, and may be disallowed when processing occurs. More...
 
const int WCL_E_OBEX_NON_AUTHORITATIVE = WCL_E_OBEX_BASE + 0x0006
 The server is a transforming proxy that received a WCL_E_SUCCESS from its origin, but is returning a modified version of the origin's response. More...
 
const int WCL_E_OBEX_NO_CONTENT = WCL_E_OBEX_BASE + 0x0007
 The server successfully processed the request and is not returning any content. More...
 
const int WCL_E_OBEX_RESET_CONTENT = WCL_E_OBEX_BASE + 0x0008
 The server successfully processed the request, but is not returning any content. Unlike a WCL_E_OBEX_NO_CONTENT error, this error requires that the requester reset the object. More...
 
const int WCL_E_OBEX_PARTIAL_CONTENT = WCL_E_OBEX_BASE + 0x0009
 The server is delivering only part of the resource due to a range header sent by the client. The range header is used by OBEX clients to enable resuming of interrupted downloads, or split a download into multiple simultaneous streams. More...
 
const int WCL_E_OBEX_MULTIPLE_CHOICES = WCL_E_OBEX_BASE + 0x000A
 Indicates multiple options for the resource from which the client may choose. More...
 
const int WCL_E_OBEX_MOVED_PERMANENTLY = WCL_E_OBEX_BASE + 0x000B
 This and all future requests should be directed to the given URI. More...
 
const int WCL_E_OBEX_MOVED_TEMPORARY = WCL_E_OBEX_BASE + 0x000C
 The response to the request can be found under another URI using the GET method. More...
 
const int WCL_E_OBEX_SEE_OTHER = WCL_E_OBEX_BASE + 0x000D
 The response to the request can be found under another URI using the GET method. More...
 
const int WCL_E_OBEX_NOT_MODIFIED = WCL_E_OBEX_BASE + 0x000E
 Indicates that the resource has not been modified since the version specified by the request headers If-Modified-Since or If-None-Match. In such case, there is no need to retransmit the resource since the client still has a previously-downloaded copy. More...
 
const int WCL_E_OBEX_USE_PROXY = WCL_E_OBEX_BASE + 0x000F
 The requested resource is available only through a proxy, the address for which is provided in the response. More...
 
const int WCL_E_OBEX_BAD_REQUEST = WCL_E_OBEX_BASE + 0x0010
 The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, size too large, invalid request message framing, or deceptive request routing). More...
 
const int WCL_E_OBEX_UNAUTHORIZED = WCL_E_OBEX_BASE + 0x0011
 Similar to WCL_E_OBEX_FORBIDDEN, but specifically for use when authentication is required and has failed or has not yet been provided. The response must include a WWW-Authenticate header field containing a challenge applicable to the requested resource. More...
 
const int WCL_E_OBEX_PAYMENT_REQUIRED = WCL_E_OBEX_BASE + 0x0012
 Reserved for future use. More...
 
const int WCL_E_OBEX_FORBIDDEN = WCL_E_OBEX_BASE + 0x0013
 The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource, or may need an account of some sort. More...
 
const int WCL_E_OBEX_NOT_FOUND = WCL_E_OBEX_BASE + 0x0014
 The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible. More...
 
const int WCL_E_OBEX_METHOD_NOT_ALLOWED = WCL_E_OBEX_BASE + 0x0015
 A request method is not supported for the requested resource. More...
 
const int WCL_E_OBEX_NOT_ACCEPTABLE = WCL_E_OBEX_BASE + 0x0016
 The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. More...
 
const int WCL_E_OBEX_PROXY_AUTH_REQUIRED = WCL_E_OBEX_BASE + 0x0017
 The client must first authenticate itself with the proxy. More...
 
const int WCL_E_OBEX_REQUEST_TIMEOUT = WCL_E_OBEX_BASE + 0x0018
 The server timed out waiting for the request. More...
 
const int WCL_E_OBEX_CONFLICT = WCL_E_OBEX_BASE + 0x0019
 Indicates that the request could not be processed because of conflict in the request, such as an edit conflict between multiple simultaneous updates. More...
 
const int WCL_E_OBEX_GONE = WCL_E_OBEX_BASE + 0x001A
 Indicates that the resource requested is no longer available and will not be available again. More...
 
const int WCL_E_OBEX_LENGTH_REQUIRED = WCL_E_OBEX_BASE + 0x001B
 The request did not specify the length of its content, which is required by the requested resource. More...
 
const int WCL_E_OBEX_PRECONDITION_FAILED = WCL_E_OBEX_BASE + 0x001C
 The server does not meet one of the preconditions that the requester put on the request. More...
 
const int WCL_E_OBEX_REQUEST_TOO_LARGE = WCL_E_OBEX_BASE + 0x001D
 The request is larger than the server is willing or able to process. More...
 
const int WCL_E_OBEX_URL_TOO_LARGE = WCL_E_OBEX_BASE + 0x001E
 The URI provided was too long for the server to process. More...
 
const int WCL_E_OBEX_UNSUPPORTED_MEDIA_TYPE = WCL_E_OBEX_BASE + 0x001F
 The request entity has a media type which the server or resource does not support. For example, the client uploads an image as image/svg+xml, but the server requires that images use a different format. More...
 
const int WCL_E_OBEX_INTERNAL = WCL_E_OBEX_BASE + 0x0020
 A generic error, given when an unexpected condition was encountered and no more specific message is suitable. More...
 
const int WCL_E_OBEX_NOT_IMPLEMENTED = WCL_E_OBEX_BASE + 0x0021
 The server either does not recognize the request method, or it lacks the ability to fulfill the request. More...
 
const int WCL_E_OBEX_BAD_GATEWAY = WCL_E_OBEX_BASE + 0x0022
 The server was acting as a gateway or proxy and received an invalid response from the upstream server. More...
 
const int WCL_E_OBEX_SERVICE_UNAVAILABLE = WCL_E_OBEX_BASE + 0x0023
 The server is currently unavailable (because it is overloaded or down for maintenance). Generally, this is a temporary state. Also this error indicates that wrong Connect ID or Target used. More...
 
const int WCL_E_OBEX_GATEWAY_TIMEOUT = WCL_E_OBEX_BASE + 0x0024
 The server was acting as a gateway or proxy and did not receive a timely response from the upstream server. More...
 
const int WCL_E_OBEX_HTTP_VERSION_NOT_SUPPORTED = WCL_E_OBEX_BASE + 0x0025
 The server does not support the HTTP protocol version used in the request.[ More...
 
const int WCL_E_OBEX_DATABASE_FULL = WCL_E_OBEX_BASE + 0x0026
 Indicates that the client requests that something be placed into a database but the database is full (cannot take more data). More...
 
const int WCL_E_OBEX_DATABASE_LOCKED = WCL_E_OBEX_BASE + 0x0027
 Returned when the client wishes to access a database, database table, or database record that has been locked. More...
 
const int WCL_E_OBEX_OPERATION_TERMINATED_BY_DISCONNECT = WCL_E_OBEX_BASE + 0x0028
 The current operation has been terminated because a remote device is disconnected. More...
 
const int WCL_E_OBEX_OPERATION_TERMINATED_BY_USER = WCL_E_OBEX_BASE + 0x0029
 The current operation has been terminated by a user. More...
 
const int WCL_E_OBEX_INVALID_OPERATION_SEQUENCE = WCL_E_OBEX_BASE + 0x002A
 The operation can not be executed at this time. This error appears if for example an application calls Terminate for Connect, Disconnect or SetPath operations. More...
 
const int WCL_E_OBEX_DISCONNECTED = WCL_E_OBEX_BASE + 0x002B
 The error code indicates that the OBEX session has been disconnected by a remote side. More...
 
const int WCL_E_OBEX_UNEXPECTED = WCL_E_OBEX_BASE + 0x002C
 Unexpected or unknown OBEX result code. More...
 
const int WCL_E_OBEX_CREATE_CONNECTION_ID_MUTEX_FAILED = WCL_E_OBEX_BASE + 0x002D
 Unable to create synchronization Mutex used to generate connection ID. More...
 
const int WCL_E_OBEX_MAX_CONNECTION_ID = WCL_E_OBEX_BASE + 0x002E
 The maximum connection ID has been reached. More...
 
const int WCL_E_OBEX_INVALID_STATE = WCL_E_OBEX_BASE + 0x002F
 Invalid data processor state. More...
 
const int WCL_E_OBEX_INVALID_DIR_LIST = WCL_E_OBEX_BASE + 0x0030
 Unable to parse directory listing. More...
 
const int WCL_E_OBEX_INVALID_DIR_FORMAT = WCL_E_OBEX_BASE + 0x0031
 Wrong directory listing format. More...
 
const int WCL_E_OBEX_COM_INIT_FAILED = WCL_E_OBEX_BASE + 0x0032
 COM initialization failed. More...
 
const int WCL_E_OBEX_XML_NOT_AVAILABLE = WCL_E_OBEX_BASE + 0x0033
 XML parser is not available. More...