BLEServer Class

Properties   Methods   Events   Config Settings   Errors  

TBD.

Syntax

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

public boolean isListening();

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.

ServerId Property (BLEServer Class)

TBD.

Syntax

public String getServerId();
public void setServerId(String serverId);

Default Value

""

Remarks

TBD.

This property is not available at design time.

AddCharacteristic Method (BLEServer Class)

TBD.

Syntax

public void addCharacteristic(String serviceId, String characteristicId, int props);

Remarks

TBD.

Config Method (BLEServer Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

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.

DoEvents Method (BLEServer Class)

This method processes events from the internal message queue.

Syntax

public void 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.

StartListening Method (BLEServer Class)

TBD.

Syntax

public void startListening(String serviceId);

Remarks

TBD.

StopListening Method (BLEServer Class)

TBD.

Syntax

public void stopListening(String serviceId);

Remarks

TBD.

AdvertisementStatusChanged Event (BLEServer Class)

TBD.

Syntax

public class DefaultBLEServerEventListener implements BLEServerEventListener {
  ...
  public void advertisementStatusChanged(BLEServerAdvertisementStatusChangedEvent e) {}
  ...
}

public class BLEServerAdvertisementStatusChangedEvent {
  public int status;
  public int error;
}

Remarks

TBD.

Connected Event (BLEServer Class)

TBD.

Syntax

public class DefaultBLEServerEventListener implements BLEServerEventListener {
  ...
  public void connected(BLEServerConnectedEvent e) {}
  ...
}

public class BLEServerConnectedEvent {
  public String clientId;
  public int statusCode;
  public String description;
}

Remarks

TBD.

Disconnected Event (BLEServer Class)

TBD.

Syntax

public class DefaultBLEServerEventListener implements BLEServerEventListener {
  ...
  public void disconnected(BLEServerDisconnectedEvent e) {}
  ...
}

public class BLEServerDisconnectedEvent {
  public String clientId;
  public int statusCode;
  public String description;
}

Remarks

TBD.

Error Event (BLEServer Class)

Fired when information is available about errors during data delivery.

Syntax

public class DefaultBLEServerEventListener implements BLEServerEventListener {
  ...
  public void error(BLEServerErrorEvent e) {}
  ...
}

public class BLEServerErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception.

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

public class DefaultBLEServerEventListener implements BLEServerEventListener {
  ...
  public void log(BLEServerLogEvent e) {}
  ...
}

public class BLEServerLogEvent {
  public int logLevel;
  public String message;
  public String logType;
}

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

public class DefaultBLEServerEventListener implements BLEServerEventListener {
  ...
  public void readRequested(BLEServerReadRequestedEvent e) {}
  ...
}

public class BLEServerReadRequestedEvent {
  public String clientId;
  public String serviceId;
  public String characteristicId;
  public String responseValue; //read-write
  public boolean accept; //read-write
}

Remarks

TBD.

SessionStatusChanged Event (BLEServer Class)

TBD.

Syntax

public class DefaultBLEServerEventListener implements BLEServerEventListener {
  ...
  public void sessionStatusChanged(BLEServerSessionStatusChangedEvent e) {}
  ...
}

public class BLEServerSessionStatusChangedEvent {
  public String clientId;
  public int status;
  public int error;
}

Remarks

TBD.

SubscriptionChanged Event (BLEServer Class)

TBD.

Syntax

public class DefaultBLEServerEventListener implements BLEServerEventListener {
  ...
  public void subscriptionChanged(BLEServerSubscriptionChangedEvent e) {}
  ...
}

public class BLEServerSubscriptionChangedEvent {
  public String serviceId;
  public String characteristicId;
  public boolean isSubscribed;
}

Remarks

TBD.

WriteRequested Event (BLEServer Class)

TBD.

Syntax

public class DefaultBLEServerEventListener implements BLEServerEventListener {
  ...
  public void writeRequested(BLEServerWriteRequestedEvent e) {}
  ...
}

public class BLEServerWriteRequestedEvent {
  public String clientId;
  public String serviceId;
  public String characteristicId;
  public byte[] value;
  public boolean withResponse;
  public boolean accept; //read-write
}

Remarks

TBD.

Config Settings (BLEServer Class)

The class accepts one or more of the following configuration settings. Configuration 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.

BLEServer Config Settings

Base Config Settings

Trappable Errors (BLEServer Class)

BLEServer Errors