IPWorks Bluetooth 2020 C++ Builder Edition

Questions / Feedback?

BTDaemon Component

Properties   Methods   Events   Configuration Settings   Errors  

A Bluetooth server component based on a high-performance, asynchronous, event-driven architecture.

Syntax

TiptBTDaemon

Remarks

The BTDaemon component implements a light-weight Bluetooth server. To begin listening for connections set Protocol and LocalPort, then set Listening to true. When a client connects the ConnectionRequest event will fire. If the incoming connection is accepted the Connected event will fire.

Once a connection is established the DataIn event will fire with data received from the client. To send data set DataToSend or call Send, SendLine, or SendFile.

Clients may be disconnected by calling Disconnect.

Property List


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

ConnectionBacklogThe maximum number of pending connections maintained by the Bluetooth subsystem.
ConnectionCountThe number of records in the arrays.
AcceptDataSetting this property to False, temporarily disables data reception (and the DataIn event) on the connection.
BytesSentThis property shows how many bytes were sent after the last assignment to DataToSend .
ConnectedThis property is used to disconnect individual connections and/or show their status.
ConnectionIdThis property contains an identifier generated by the component to identify each connection.
DataToSendThis property contains a string of data to be sent to the remote host.
EOLThe EOL property is used to define boundaries in the input stream using the value of the property.
IdleTimeoutThe idle timeout for this connection.
LocalAddressThis property shows the IP address of the interface through which the connection is passing.
ReadyToSendIndicates whether the component is ready to send data.
RecordLengthIf set to a positive value, this setting defines the length of data records to be received.
RemoteHostThis property shows the IP address of the remote host through which the connection is coming.
RemotePortThis property shows the TCP port on the remote host through which the connection is coming.
SingleLineModeThis property shows the special mode for line-oriented protocols.
TimeoutThis property specifies a timeout for the component.
UserDataThe UserData property holds connection specific user specified data.
DefaultEOLA default EOL value to be used by incoming connections.
DefaultMaxLineLengthThe default maximum line length value for inbound connections.
DefaultSingleLineModeTells the component whether or not to treat new connections as line-oriented.
DefaultTimeoutAn initial timeout value to be used by incoming connections.
ListeningIf True, the component accepts incoming connections on LocalPort.
LocalHostThe address of the Bluetooth device through which connections are initiated or accepted.
LocalPortThe port in the Bluetooth device on which the component listens.
ProtocolThe Bluetooth protocol to be used.
SSLAuthenticateClientsIf true, the server asks the client(s) for a certificate.
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLEnabledWhether TLS/SSL is enabled.
SSLStartModeDetermines how the component starts the SSL negotiation.

Method List


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

ConfigSets or retrieves a configuration setting.
DisconnectDisconnect the specified client.
DoEventsProcesses events from the internal message queue.
InterruptInterrupts a synchronous send to the remote host.
SendSends data to the remote host.
SendFileSend file to the remote host.
SendLineSends a string followed by a newline.
ShutdownShuts down the server.
StartSSLStarts SSL negotiation on a connection.

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.

ConnectedFired immediately after a connection completes (or fails).
ConnectionRequestFired when a request for connection comes from a remote host.
DataInFired when data comes in.
DisconnectedFired when a connection is closed.
ErrorInformation about errors during data delivery.
ReadyToSendFired when the component is ready to send data.
SSLClientAuthenticationFired when the client presents its credentials to the server.
SSLConnectionRequestFires when an SSL connection is requested.
SSLStatusShows the progress of the secure connection.

Configuration Settings


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

BTAuthenticateWhether authentication is required.
BTDefaultMTUThe default RFCOMM MTU (Maximum Transmission Unit).
BTEncryptForces an encrypted connection if set to True.
BTMTUMaxThe maximum RFCOMM MTU (Maximum Transmission Unit).
BTMTUMinThe minimum RFCOMM MTU (Maximum Transmission Unit).
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks Bluetooth 2020 C++ Builder Edition - Version 20.0 [Build 7941]