BLEServer Class

Properties   Methods   Events   Config Settings   Errors  

TBD.

Syntax

BLEServer

Remarks

TBD.

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.

Listening Property (BLEServer Class)

This property indicates whether the class is listening for incoming connections on LocalPort.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetListening();

Unicode (Windows)
BOOL GetListening();

int ipworksble_bleserver_getlistening(void* lpObj);

bool getListening();

Default Value

FALSE

Remarks

This property indicates whether the class is listening for connections on the port specified by the LocalPort property. Use the StartListening and StopListening methods to control whether the class is listening.

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

Data Type

Boolean

ServerId Property (BLEServer Class)

TBD.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerId();
int SetServerId(const char* lpszServerId);

Unicode (Windows)
LPWSTR GetServerId();
INT SetServerId(LPCWSTR lpszServerId);

char* ipworksble_bleserver_getserverid(void* lpObj);
int ipworksble_bleserver_setserverid(void* lpObj, const char* lpszServerId);

QString getServerId();
int setServerId(QString qsServerId);

Default Value

""

Remarks

TBD.

This property is not available at design time.

Data Type

String

AddCharacteristic Method (BLEServer Class)

TBD.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddCharacteristic(const char* lpszServiceId, const char* lpszCharacteristicId, int iProps);

Unicode (Windows)
INT AddCharacteristic(LPCWSTR lpszServiceId, LPCWSTR lpszCharacteristicId, INT iProps);

int ipworksble_bleserver_addcharacteristic(void* lpObj, const char* lpszServiceId, const char* lpszCharacteristicId, int iProps);

int addCharacteristic(const QString& qsServiceId, const QString& qsCharacteristicId, int iProps);

Remarks

TBD.

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

Config Method (BLEServer 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* ipworksble_bleserver_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.

DoEvents Method (BLEServer Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

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

StartListening Method (BLEServer Class)

TBD.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartListening(const char* lpszServiceId);

Unicode (Windows)
INT StartListening(LPCWSTR lpszServiceId);

int ipworksble_bleserver_startlistening(void* lpObj, const char* lpszServiceId);

int startListening(const QString& qsServiceId);

Remarks

TBD.

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

TBD.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StopListening(const char* lpszServiceId);

Unicode (Windows)
INT StopListening(LPCWSTR lpszServiceId);

int ipworksble_bleserver_stoplistening(void* lpObj, const char* lpszServiceId);

int stopListening(const QString& qsServiceId);

Remarks

TBD.

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

AdvertisementStatusChanged Event (BLEServer Class)

TBD.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireAdvertisementStatusChanged(BLEServerAdvertisementStatusChangedEventParams *e);

typedef struct {
  int Status;
  int Error;
  int reserved;
} BLEServerAdvertisementStatusChangedEventParams;


Unicode (Windows)
virtual INT FireAdvertisementStatusChanged(BLEServerAdvertisementStatusChangedEventParams *e);

typedef struct {
  INT Status;
  INT Error;
  INT reserved;
} BLEServerAdvertisementStatusChangedEventParams;

#define EID_BLESERVER_ADVERTISEMENTSTATUSCHANGED 1

virtual INT IPWORKSBLE_CALL FireAdvertisementStatusChanged(INT &iStatus, INT &iError);

class BLEServerAdvertisementStatusChangedEventParams {
public:
  int status();

  int error();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass BLEServer and override this emitter function.
virtual int fireAdvertisementStatusChanged(BLEServerAdvertisementStatusChangedEventParams *e) {...}
// Or, connect one or more slots to this signal.
void advertisementStatusChanged(BLEServerAdvertisementStatusChangedEventParams *e);

Remarks

TBD.

Connected Event (BLEServer Class)

TBD.

Syntax

• C++
• C
• Qt

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

typedef struct {
  const char *ClientId;
  int StatusCode;
  const char *Description;
  int reserved;
} BLEServerConnectedEventParams;


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

typedef struct {
  LPCWSTR ClientId;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} BLEServerConnectedEventParams;

#define EID_BLESERVER_CONNECTED 2

virtual INT IPWORKSBLE_CALL FireConnected(LPSTR &lpszClientId, INT &iStatusCode, LPSTR &lpszDescription);

class BLEServerConnectedEventParams {
public:
  const QString &clientId();

  int statusCode();

  const QString &description();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass BLEServer and override this emitter function.
virtual int fireConnected(BLEServerConnectedEventParams *e) {...}
// Or, connect one or more slots to this signal.
void connected(BLEServerConnectedEventParams *e);

Remarks

TBD.

Disconnected Event (BLEServer Class)

TBD.

Syntax

• C++
• C
• Qt

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

typedef struct {
  const char *ClientId;
  int StatusCode;
  const char *Description;
  int reserved;
} BLEServerDisconnectedEventParams;


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

typedef struct {
  LPCWSTR ClientId;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} BLEServerDisconnectedEventParams;

#define EID_BLESERVER_DISCONNECTED 3

virtual INT IPWORKSBLE_CALL FireDisconnected(LPSTR &lpszClientId, INT &iStatusCode, LPSTR &lpszDescription);

class BLEServerDisconnectedEventParams {
public:
  const QString &clientId();

  int statusCode();

  const QString &description();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass BLEServer and override this emitter function.
virtual int fireDisconnected(BLEServerDisconnectedEventParams *e) {...}
// Or, connect one or more slots to this signal.
void disconnected(BLEServerDisconnectedEventParams *e);

Remarks

TBD.

Error Event (BLEServer Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_BLESERVER_ERROR 4

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

class BLEServerErrorEventParams {
public:
  int errorCode();

  const QString &description();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass BLEServer and override this emitter function.
virtual int fireError(BLEServerErrorEventParams *e) {...}
// Or, connect one or more slots to this signal.
void error(BLEServerErrorEventParams *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.

Log Event (BLEServer Class)

Fires once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(BLEServerLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} BLEServerLogEventParams;


Unicode (Windows)
virtual INT FireLog(BLEServerLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} BLEServerLogEventParams;

#define EID_BLESERVER_LOG 5

virtual INT IPWORKSBLE_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class BLEServerLogEventParams {
public:
  int logLevel();

  const QString &message();

  const QString &logType();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass BLEServer and override this emitter function.
virtual int fireLog(BLEServerLogEventParams *e) {...}
// Or, connect one or more slots to this signal.
void log(BLEServerLogEventParams *e);

Remarks

This events fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of the Message. Possible values are:

The default log level, Info, provides information when most BLE operations begin and end, and should be sufficient to get a good idea of what the class is doing at a high level.

The Verbose log level adds a few extra operation timing messages, and adds more detail to some messages logged at the Info level.

The Debug log level causes the class to output as much information as possible about what it is doing at all times. All BLE communications, even those which are typically abstracted away by the API, are logged in full detail. Typically the additional information added by this log level is not helpful to the end user, and would only be necessary to capture if you wish to report an issue to the support team.

LogType identifies the type of log entry. Possible values are:

• Scanning: Messages relating to scanning and advertisements.
• Connection: Messages relating to connecting, disconnecting, and connection failures.
• Discovery: Messages relating to any service, characteristic, or descriptor discovery process.
• Read: Messages relating to reading values from the remote device.
• Write: Messages relating to writing values to the remote device.
• Subscriptions: Messages relating to subscribing to and unsubscribing from characteristics.
• Info, Verbose, and Debug: Miscellaneous messages fired at the applicable log level concerning internal class operations.

ReadRequested Event (BLEServer Class)

TBD.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireReadRequested(BLEServerReadRequestedEventParams *e);

typedef struct {
  const char *ClientId;
  const char *ServiceId;
  const char *CharacteristicId;
  char *ResponseValue;
  int Accept;
  int reserved;
} BLEServerReadRequestedEventParams;


Unicode (Windows)
virtual INT FireReadRequested(BLEServerReadRequestedEventParams *e);

typedef struct {
  LPCWSTR ClientId;
  LPCWSTR ServiceId;
  LPCWSTR CharacteristicId;
  LPWSTR ResponseValue;
  BOOL Accept;
  INT reserved;
} BLEServerReadRequestedEventParams;

#define EID_BLESERVER_READREQUESTED 6

virtual INT IPWORKSBLE_CALL FireReadRequested(LPSTR &lpszClientId, LPSTR &lpszServiceId, LPSTR &lpszCharacteristicId, LPSTR &lpszResponseValue, BOOL &bAccept);

class BLEServerReadRequestedEventParams {
public:
  const QString &clientId();

  const QString &serviceId();

  const QString &characteristicId();

  const QString &responseValue();
  void setResponseValue(const QString &qsResponseValue);

  bool accept();
  void setAccept(bool bAccept);

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass BLEServer and override this emitter function.
virtual int fireReadRequested(BLEServerReadRequestedEventParams *e) {...}
// Or, connect one or more slots to this signal.
void readRequested(BLEServerReadRequestedEventParams *e);

Remarks

TBD.

SessionStatusChanged Event (BLEServer Class)

TBD.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSessionStatusChanged(BLEServerSessionStatusChangedEventParams *e);

typedef struct {
  const char *ClientId;
  int Status;
  int Error;
  int reserved;
} BLEServerSessionStatusChangedEventParams;


Unicode (Windows)
virtual INT FireSessionStatusChanged(BLEServerSessionStatusChangedEventParams *e);

typedef struct {
  LPCWSTR ClientId;
  INT Status;
  INT Error;
  INT reserved;
} BLEServerSessionStatusChangedEventParams;

#define EID_BLESERVER_SESSIONSTATUSCHANGED 7

virtual INT IPWORKSBLE_CALL FireSessionStatusChanged(LPSTR &lpszClientId, INT &iStatus, INT &iError);

class BLEServerSessionStatusChangedEventParams {
public:
  const QString &clientId();

  int status();

  int error();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass BLEServer and override this emitter function.
virtual int fireSessionStatusChanged(BLEServerSessionStatusChangedEventParams *e) {...}
// Or, connect one or more slots to this signal.
void sessionStatusChanged(BLEServerSessionStatusChangedEventParams *e);

Remarks

TBD.

SubscriptionChanged Event (BLEServer Class)

TBD.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSubscriptionChanged(BLEServerSubscriptionChangedEventParams *e);

typedef struct {
  const char *ServiceId;
  const char *CharacteristicId;
  int IsSubscribed;
  int reserved;
} BLEServerSubscriptionChangedEventParams;


Unicode (Windows)
virtual INT FireSubscriptionChanged(BLEServerSubscriptionChangedEventParams *e);

typedef struct {
  LPCWSTR ServiceId;
  LPCWSTR CharacteristicId;
  BOOL IsSubscribed;
  INT reserved;
} BLEServerSubscriptionChangedEventParams;

#define EID_BLESERVER_SUBSCRIPTIONCHANGED 8

virtual INT IPWORKSBLE_CALL FireSubscriptionChanged(LPSTR &lpszServiceId, LPSTR &lpszCharacteristicId, BOOL &bIsSubscribed);

class BLEServerSubscriptionChangedEventParams {
public:
  const QString &serviceId();

  const QString &characteristicId();

  bool isSubscribed();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass BLEServer and override this emitter function.
virtual int fireSubscriptionChanged(BLEServerSubscriptionChangedEventParams *e) {...}
// Or, connect one or more slots to this signal.
void subscriptionChanged(BLEServerSubscriptionChangedEventParams *e);

Remarks

TBD.

WriteRequested Event (BLEServer Class)

TBD.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireWriteRequested(BLEServerWriteRequestedEventParams *e);

typedef struct {
  const char *ClientId;
  const char *ServiceId;
  const char *CharacteristicId;
  const char *Value;
  int lenValue;
  int WithResponse;
  int Accept;
  int reserved;
} BLEServerWriteRequestedEventParams;


Unicode (Windows)
virtual INT FireWriteRequested(BLEServerWriteRequestedEventParams *e);

typedef struct {
  LPCWSTR ClientId;
  LPCWSTR ServiceId;
  LPCWSTR CharacteristicId;
  LPCSTR Value;
  INT lenValue;
  BOOL WithResponse;
  BOOL Accept;
  INT reserved;
} BLEServerWriteRequestedEventParams;

#define EID_BLESERVER_WRITEREQUESTED 9

virtual INT IPWORKSBLE_CALL FireWriteRequested(LPSTR &lpszClientId, LPSTR &lpszServiceId, LPSTR &lpszCharacteristicId, LPSTR &lpValue, INT &lenValue, BOOL &bWithResponse, BOOL &bAccept);

class BLEServerWriteRequestedEventParams {
public:
  const QString &clientId();

  const QString &serviceId();

  const QString &characteristicId();

  const QByteArray &value();

  bool withResponse();

  bool accept();
  void setAccept(bool bAccept);

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass BLEServer and override this emitter function.
virtual int fireWriteRequested(BLEServerWriteRequestedEventParams *e) {...}
// Or, connect one or more slots to this signal.
void writeRequested(BLEServerWriteRequestedEventParams *e);

Remarks

TBD.

Config Settings (BLEServer Class)

BLEServer Config Settings

Base Config Settings

Trappable Errors (BLEServer 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.

BLEServer Errors