BLEServer Component

Properties   Methods   Events   Config Settings   Errors  

TBD.

Syntax

nsoftware.IPWorksBLE.BLEServer

Remarks

TBD.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

Listening Property (BLEServer Component)

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

Syntax

• C#
• VB.NET

public bool Listening { get; }

Public ReadOnly Property Listening As Boolean

Default Value

False

Remarks

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

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

ServerId Property (BLEServer Component)

TBD.

Syntax

• C#
• VB.NET

public string ServerId { get; set; }

Public Property ServerId As String

Default Value

""

Remarks

TBD.

This property is not available at design time.

AddCharacteristic Method (BLEServer Component)

TBD.

Syntax

• C#
• VB.NET

public void AddCharacteristic(string serviceId, string characteristicId, int props);

Async Version
public async Task AddCharacteristic(string serviceId, string characteristicId, int props);
public async Task AddCharacteristic(string serviceId, string characteristicId, int props, CancellationToken cancellationToken);

Public Sub AddCharacteristic(ByVal ServiceId As String, ByVal CharacteristicId As String, ByVal Props As Integer)

Async Version
Public Sub AddCharacteristic(ByVal ServiceId As String, ByVal CharacteristicId As String, ByVal Props As Integer) As Task
Public Sub AddCharacteristic(ByVal ServiceId As String, ByVal CharacteristicId As String, ByVal Props As Integer, cancellationToken As CancellationToken) As Task

Remarks

TBD.

Config Method (BLEServer Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 Component)

This method processes events from the internal message queue.

Syntax

• C#
• VB.NET

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);

Public Sub DoEvents()

Async Version
Public Sub DoEvents() As Task
Public Sub DoEvents(cancellationToken As CancellationToken) As Task

Remarks

When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.

StartListening Method (BLEServer Component)

TBD.

Syntax

• C#
• VB.NET

public void StartListening(string serviceId);

Async Version
public async Task StartListening(string serviceId);
public async Task StartListening(string serviceId, CancellationToken cancellationToken);

Public Sub StartListening(ByVal ServiceId As String)

Async Version
Public Sub StartListening(ByVal ServiceId As String) As Task
Public Sub StartListening(ByVal ServiceId As String, cancellationToken As CancellationToken) As Task

Remarks

TBD.

StopListening Method (BLEServer Component)

TBD.

Syntax

• C#
• VB.NET

public void StopListening(string serviceId);

Async Version
public async Task StopListening(string serviceId);
public async Task StopListening(string serviceId, CancellationToken cancellationToken);

Public Sub StopListening(ByVal ServiceId As String)

Async Version
Public Sub StopListening(ByVal ServiceId As String) As Task
Public Sub StopListening(ByVal ServiceId As String, cancellationToken As CancellationToken) As Task

Remarks

TBD.

AdvertisementStatusChanged Event (BLEServer Component)

TBD.

Syntax

• C#
• VB.NET

public event OnAdvertisementStatusChangedHandler OnAdvertisementStatusChanged;

public delegate void OnAdvertisementStatusChangedHandler(object sender, BLEServerAdvertisementStatusChangedEventArgs e);

public class BLEServerAdvertisementStatusChangedEventArgs : EventArgs {
  public int Status { get; }
  public int Error { get; }
}

Public Event OnAdvertisementStatusChanged As OnAdvertisementStatusChangedHandler

Public Delegate Sub OnAdvertisementStatusChangedHandler(sender As Object, e As BLEServerAdvertisementStatusChangedEventArgs)

Public Class BLEServerAdvertisementStatusChangedEventArgs Inherits EventArgs
  Public ReadOnly Property Status As Integer
  Public ReadOnly Property Error As Integer
End Class

Remarks

TBD.

Connected Event (BLEServer Component)

TBD.

Syntax

• C#
• VB.NET

public event OnConnectedHandler OnConnected;

public delegate void OnConnectedHandler(object sender, BLEServerConnectedEventArgs e);

public class BLEServerConnectedEventArgs : EventArgs {
  public string ClientId { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnected As OnConnectedHandler

Public Delegate Sub OnConnectedHandler(sender As Object, e As BLEServerConnectedEventArgs)

Public Class BLEServerConnectedEventArgs Inherits EventArgs
  Public ReadOnly Property ClientId As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

TBD.

Disconnected Event (BLEServer Component)

TBD.

Syntax

• C#
• VB.NET

public event OnDisconnectedHandler OnDisconnected;

public delegate void OnDisconnectedHandler(object sender, BLEServerDisconnectedEventArgs e);

public class BLEServerDisconnectedEventArgs : EventArgs {
  public string ClientId { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnDisconnected As OnDisconnectedHandler

Public Delegate Sub OnDisconnectedHandler(sender As Object, e As BLEServerDisconnectedEventArgs)

Public Class BLEServerDisconnectedEventArgs Inherits EventArgs
  Public ReadOnly Property ClientId As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

TBD.

Error Event (BLEServer Component)

Fired when information is available about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, BLEServerErrorEventArgs e);

public class BLEServerErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As BLEServerErrorEventArgs)

Public Class BLEServerErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component 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 Component)

Fires once for each log message.

Syntax

• C#
• VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, BLEServerLogEventArgs e);

public class BLEServerLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As BLEServerLogEventArgs)

Public Class BLEServerLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

Remarks

This events fires once for each log message generated by the component. 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 component 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 component 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 component operations.

ReadRequested Event (BLEServer Component)

TBD.

Syntax

• C#
• VB.NET

public event OnReadRequestedHandler OnReadRequested;

public delegate void OnReadRequestedHandler(object sender, BLEServerReadRequestedEventArgs e);

public class BLEServerReadRequestedEventArgs : EventArgs {
  public string ClientId { get; }
  public string ServiceId { get; }
  public string CharacteristicId { get; }
  public string ResponseValue { get; set; }
  public bool Accept { get; set; }
}

Public Event OnReadRequested As OnReadRequestedHandler

Public Delegate Sub OnReadRequestedHandler(sender As Object, e As BLEServerReadRequestedEventArgs)

Public Class BLEServerReadRequestedEventArgs Inherits EventArgs
  Public ReadOnly Property ClientId As String
  Public ReadOnly Property ServiceId As String
  Public ReadOnly Property CharacteristicId As String
  Public Property ResponseValue As String
  Public Property Accept As Boolean
End Class

Remarks

TBD.

SessionStatusChanged Event (BLEServer Component)

TBD.

Syntax

• C#
• VB.NET

public event OnSessionStatusChangedHandler OnSessionStatusChanged;

public delegate void OnSessionStatusChangedHandler(object sender, BLEServerSessionStatusChangedEventArgs e);

public class BLEServerSessionStatusChangedEventArgs : EventArgs {
  public string ClientId { get; }
  public int Status { get; }
  public int Error { get; }
}

Public Event OnSessionStatusChanged As OnSessionStatusChangedHandler

Public Delegate Sub OnSessionStatusChangedHandler(sender As Object, e As BLEServerSessionStatusChangedEventArgs)

Public Class BLEServerSessionStatusChangedEventArgs Inherits EventArgs
  Public ReadOnly Property ClientId As String
  Public ReadOnly Property Status As Integer
  Public ReadOnly Property Error As Integer
End Class

Remarks

TBD.

SubscriptionChanged Event (BLEServer Component)

TBD.

Syntax

• C#
• VB.NET

public event OnSubscriptionChangedHandler OnSubscriptionChanged;

public delegate void OnSubscriptionChangedHandler(object sender, BLEServerSubscriptionChangedEventArgs e);

public class BLEServerSubscriptionChangedEventArgs : EventArgs {
  public string ServiceId { get; }
  public string CharacteristicId { get; }
  public bool IsSubscribed { get; }
}

Public Event OnSubscriptionChanged As OnSubscriptionChangedHandler

Public Delegate Sub OnSubscriptionChangedHandler(sender As Object, e As BLEServerSubscriptionChangedEventArgs)

Public Class BLEServerSubscriptionChangedEventArgs Inherits EventArgs
  Public ReadOnly Property ServiceId As String
  Public ReadOnly Property CharacteristicId As String
  Public ReadOnly Property IsSubscribed As Boolean
End Class

Remarks

TBD.

WriteRequested Event (BLEServer Component)

TBD.

Syntax

• C#
• VB.NET

public event OnWriteRequestedHandler OnWriteRequested;

public delegate void OnWriteRequestedHandler(object sender, BLEServerWriteRequestedEventArgs e);

public class BLEServerWriteRequestedEventArgs : EventArgs {
  public string ClientId { get; }
  public string ServiceId { get; }
  public string CharacteristicId { get; }
  public string Value { get; }
  public byte[] ValueB { get; }
  public bool WithResponse { get; }
  public bool Accept { get; set; }
}

Public Event OnWriteRequested As OnWriteRequestedHandler

Public Delegate Sub OnWriteRequestedHandler(sender As Object, e As BLEServerWriteRequestedEventArgs)

Public Class BLEServerWriteRequestedEventArgs Inherits EventArgs
  Public ReadOnly Property ClientId As String
  Public ReadOnly Property ServiceId As String
  Public ReadOnly Property CharacteristicId As String
  Public ReadOnly Property Value As String
  Public ReadOnly Property ValueB As Byte()
  Public ReadOnly Property WithResponse As Boolean
  Public Property Accept As Boolean
End Class

Remarks

TBD.

Config Settings (BLEServer Component)

BLEServer Config Settings

Base Config Settings

Trappable Errors (BLEServer Component)

BLEServer Errors