| Package | Description |
|---|---|
| com.microsoft.azure.sdk.iot.device |
The API for a device to communicate with an IoT Hub.
|
| com.microsoft.azure.sdk.iot.device.exceptions | |
| com.microsoft.azure.sdk.iot.device.transport |
A transport for sending and receiving IoT Hub messages, along with supporting
functionality.
|
| com.microsoft.azure.sdk.iot.device.twin |
| Modifier and Type | Method and Description |
|---|---|
static IotHubClientException |
IotHubStatusCode.toException(IotHubStatusCode statusCode) |
| Modifier and Type | Method and Description |
|---|---|
void |
MessageSentCallback.onMessageSent(Message sentMessage,
IotHubClientException clientException,
java.lang.Object callbackContext)
The callback that is executed once the message associated with this callback has been acknowledged by the service.
|
void |
MessagesSentCallback.onMessagesSent(java.util.List<Message> sentMessages,
IotHubClientException clientException,
java.lang.Object callbackContext)
The callback that is executed once the messages associated with this callback has been acknowledged by the service.
|
void |
CorrelatingMessageCallback.onRequestAcknowledged(Message message,
java.lang.Object callbackContext,
IotHubClientException e)
Called when the message request has been sent and IoT hub has acknowledged the request.
|
void |
CorrelatingMessageCallback.onResponseReceived(Message message,
java.lang.Object callbackContext,
IotHubClientException e)
Called when a response to the sent message has been sent by IoT hub and has been receieved by the transport.
|
| Modifier and Type | Method and Description |
|---|---|
void |
DeviceClient.completeFileUpload(FileUploadCompletionNotification notification)
Notify IoT hub that a file upload has been completed, successfully or otherwise.
|
static ModuleClient |
ModuleClient.createFromEnvironment(UnixDomainSocketChannel unixDomainSocketChannel)
Create a module client instance from your environment variables
|
static ModuleClient |
ModuleClient.createFromEnvironment(UnixDomainSocketChannel unixDomainSocketChannel,
IotHubClientProtocol protocol)
Create a module client instance from your environment variables
|
static ModuleClient |
ModuleClient.createFromEnvironment(UnixDomainSocketChannel unixDomainSocketChannel,
IotHubClientProtocol protocol,
ClientOptions clientOptions)
Create a module client instance from your environment variables
|
FileUploadSasUriResponse |
DeviceClient.getFileUploadSasUri(FileUploadSasUriRequest request)
Get a file upload SAS URI which the Azure Storage SDK can use to upload a file to blob for this device.
|
Twin |
InternalClient.getTwin()
Get the twin for this client.
|
Twin |
InternalClient.getTwin(int timeoutMilliseconds)
Get the twin for this client.
|
DirectMethodResponse |
ModuleClient.invokeMethod(java.lang.String deviceId,
DirectMethodRequest directMethodRequest)
Invoke a method on a device
|
DirectMethodResponse |
ModuleClient.invokeMethod(java.lang.String deviceId,
java.lang.String moduleId,
DirectMethodRequest directMethodRequest)
Invoke a method on a module
|
void |
MultiplexingClient.open(boolean withRetry)
Opens this multiplexing client.
|
void |
InternalClient.open(boolean withRetry)
Starts asynchronously sending and receiving messages from an IoT hub.
|
void |
DeviceClient.open(boolean withRetry)
Starts asynchronously sending and receiving messages from an IoT hub.
|
void |
MultiplexingClient.registerDeviceClient(DeviceClient deviceClient)
Register a device client to this multiplexing client.
|
void |
MultiplexingClient.registerDeviceClient(DeviceClient deviceClient,
long timeoutMilliseconds)
Register a device client to this multiplexing client.
|
void |
MultiplexingClient.registerDeviceClients(java.lang.Iterable<DeviceClient> deviceClients)
Register multiple device clients to this multiplexing client.
|
void |
MultiplexingClient.registerDeviceClients(java.lang.Iterable<DeviceClient> deviceClients,
long timeoutMilliseconds)
Register multiple device clients to this multiplexing client.
|
void |
ModuleClient.sendEvent(Message message) |
void |
InternalClient.sendEvent(Message message)
Synchronously sends a message to IoT hub.
|
void |
InternalClient.sendEvent(Message message,
int timeoutMilliseconds)
Synchronously sends a message to IoT hub.
|
void |
ModuleClient.sendEvent(Message message,
java.lang.String outputName)
Synchronously sends a message to to a particular outputName.
|
void |
ModuleClient.sendEvent(Message message,
java.lang.String outputName,
int timeoutMilliseconds)
Synchronously sends a message to to a particular outputName.
|
void |
InternalClient.sendEvents(java.util.List<Message> messages)
Synchronously sends a batch of messages to IoT hub
This operation is only supported over HTTPS.
|
void |
InternalClient.sendEvents(java.util.List<Message> messages,
int timeoutMilliseconds)
Synchronously sends a batch of messages to IoT hub
This operation is only supported over HTTPS.
|
void |
InternalClient.subscribeToDesiredProperties(DesiredPropertiesCallback desiredPropertiesCallback,
java.lang.Object desiredPropertiesCallbackContext)
Start receiving desired property updates for this client.
|
void |
InternalClient.subscribeToDesiredProperties(DesiredPropertiesCallback desiredPropertiesCallback,
java.lang.Object desiredPropertiesCallbackContext,
int timeoutMilliseconds)
Start receiving desired property updates for this client.
|
void |
InternalClient.subscribeToMethods(MethodCallback methodCallback,
java.lang.Object methodCallbackContext)
Subscribes to direct methods.
|
void |
InternalClient.subscribeToMethods(MethodCallback methodCallback,
java.lang.Object methodCallbackContext,
int timeoutMilliseconds)
Subscribes to direct methods.
|
void |
MultiplexingClient.unregisterDeviceClient(DeviceClient deviceClient)
Unregister a device client from this multiplexing client.
|
void |
MultiplexingClient.unregisterDeviceClient(DeviceClient deviceClient,
long timeoutMilliseconds)
Unregister a device client from this multiplexing client.
|
void |
MultiplexingClient.unregisterDeviceClients(java.lang.Iterable<DeviceClient> deviceClients)
Unregister multiple device clients from this multiplexing client.
|
void |
MultiplexingClient.unregisterDeviceClients(java.lang.Iterable<DeviceClient> deviceClients,
long timeoutMilliseconds)
Unregister multiple device clients from this multiplexing client.
|
ReportedPropertiesUpdateResponse |
InternalClient.updateReportedProperties(TwinCollection reportedProperties)
Patch this client's twin with the provided reported properties.
|
ReportedPropertiesUpdateResponse |
InternalClient.updateReportedProperties(TwinCollection reportedProperties,
int timeoutMilliseconds)
Patch this client's twin with the provided reported properties.
|
| Modifier and Type | Class and Description |
|---|---|
class |
MultiplexingClientRegistrationException
Exception that is thrown when one or more devices fail to register to an active multiplexed connection.
|
| Modifier and Type | Method and Description |
|---|---|
IotHubClientException |
TransportException.toIotHubClientException() |
| Modifier and Type | Method and Description |
|---|---|
void |
IotHubTransport.open(boolean withRetry)
Establishes a communication channel with an IoT Hub.
|
void |
IotHubTransport.registerMultiplexedDeviceClient(java.util.List<ClientConfiguration> configs,
long timeoutMilliseconds) |
void |
IotHubTransport.unregisterMultiplexedDeviceClient(java.util.List<ClientConfiguration> configs,
long timeoutMilliseconds) |
| Modifier and Type | Method and Description |
|---|---|
void |
ReportedPropertiesCallback.onReportedPropertiesUpdateAcknowledged(IotHubStatusCode statusCode,
ReportedPropertiesUpdateResponse response,
IotHubClientException e,
java.lang.Object context)
The callback that is executed when the reported properties update request has completed.
|
void |
ReportedPropertiesUpdateCorrelatingMessageCallback.onRequestAcknowledged(Message message,
java.lang.Object callbackContext,
IotHubClientException e)
Called when the message request has been sent and IoT hub has acknowledged the request.
|
void |
GetTwinCorrelatingMessageCallback.onRequestAcknowledged(Message message,
java.lang.Object callbackContext,
IotHubClientException e)
Called when the message request has been sent and IoT hub has acknowledged the request.
|
void |
ReportedPropertiesUpdateCorrelatingMessageCallback.onResponseReceived(Message message,
java.lang.Object callbackContext,
IotHubStatusCode statusCode,
ReportedPropertiesUpdateResponse response,
IotHubClientException e)
Called when a response to the sent message has been sent by IoT hub and has been receieved by the transport.
|
void |
GetTwinCorrelatingMessageCallback.onResponseReceived(Twin twin,
Message message,
java.lang.Object callbackContext,
IotHubStatusCode statusCode,
IotHubClientException e)
Called when a response to the sent message has been sent by IoT hub and has been receieved by the transport.
|
void |
SubscriptionAcknowledgedCallback.onSubscriptionAcknowledged(IotHubClientException exception,
java.lang.Object context)
The callback that is executed when the request to subscribe to desired properties or direct methodshas been
acknowledged by the service.
|
void |
GetTwinCallback.onTwinReceived(Twin twin,
IotHubClientException clientException,
java.lang.Object context)
The callback to be executed when the service responds to a getTwin request with the current twin.
|
Copyright © 2023. All rights reserved.