azure-docs-sdk-java/docs-ref-autogen/com.microsoft.azure.sdk.iot...

233 строки
21 KiB
YAML

### YamlMime:JavaType
uid: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver"
fullName: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver"
name: "FeedbackReceiver"
nameWithType: "FeedbackReceiver"
summary: "Feedback<wbr>Receiver is a specialized receiver whose Receive<wbr>Async method returns a Feedback<wbr>Batch instead of a Message."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.sdk.iot.service.Receiver?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.microsoft.azure.sdk.iot.service.Receiver?alt=com.microsoft.azure.sdk.iot.service.Receiver&text=Receiver\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.microsoft.azure.sdk.iot.service.Receiver.closeAsync()?alt=com.microsoft.azure.sdk.iot.service.Receiver.closeAsync&text=closeAsync\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.sdk.iot.service.Receiver.openAsync()?alt=com.microsoft.azure.sdk.iot.service.Receiver.openAsync&text=openAsync\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.sdk.iot.service.Receiver.receiveAsync()?alt=com.microsoft.azure.sdk.iot.service.Receiver.receiveAsync&text=receiveAsync\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.sdk.iot.service.Receiver.receiveAsync(long)?alt=com.microsoft.azure.sdk.iot.service.Receiver.receiveAsync&text=receiveAsync\" data-throw-if-not-resolved=\"False\" />"
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **FeedbackReceiver**</br> extends <xref href=\"com.microsoft.azure.sdk.iot.service.Receiver?alt=com.microsoft.azure.sdk.iot.service.Receiver&text=Receiver\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.FeedbackReceiver(java.lang.String,java.lang.String,java.lang.String,com.microsoft.azure.sdk.iot.service.IotHubServiceClientProtocol)"
fullName: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol)"
name: "FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol)"
nameWithType: "FeedbackReceiver.FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol)"
summary: "Constructor to verify initialization parameters Create instance of Amqp<wbr>Receive"
parameters:
- description: "The iot hub host name"
name: "hostName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The iot hub user name"
name: "userName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The iot hub SAS token for the given device"
name: "sasToken"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "protocol to be used"
name: "iotHubServiceClientProtocol"
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.IotHubServiceClientProtocol?alt=com.microsoft.azure.sdk.iot.service.IotHubServiceClientProtocol&text=IotHubServiceClientProtocol\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol)"
desc: "Constructor to verify initialization parameters Create instance of AmqpReceive"
- uid: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.FeedbackReceiver(java.lang.String,java.lang.String,java.lang.String,com.microsoft.azure.sdk.iot.service.IotHubServiceClientProtocol,com.microsoft.azure.sdk.iot.service.ProxyOptions)"
fullName: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, ProxyOptions proxyOptions)"
name: "FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, ProxyOptions proxyOptions)"
nameWithType: "FeedbackReceiver.FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, ProxyOptions proxyOptions)"
summary: "Constructor to verify initialization parameters Create instance of Amqp<wbr>Receive"
parameters:
- description: "The iot hub host name"
name: "hostName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The iot hub user name"
name: "userName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The iot hub SAS token for the given device"
name: "sasToken"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "protocol to be used"
name: "iotHubServiceClientProtocol"
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.IotHubServiceClientProtocol?alt=com.microsoft.azure.sdk.iot.service.IotHubServiceClientProtocol&text=IotHubServiceClientProtocol\" data-throw-if-not-resolved=\"False\" />"
- description: "the proxy options to tunnel through, if a proxy should be used."
name: "proxyOptions"
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.ProxyOptions?alt=com.microsoft.azure.sdk.iot.service.ProxyOptions&text=ProxyOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, ProxyOptions proxyOptions)"
desc: "Constructor to verify initialization parameters Create instance of AmqpReceive"
- uid: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.FeedbackReceiver(java.lang.String,java.lang.String,java.lang.String,com.microsoft.azure.sdk.iot.service.IotHubServiceClientProtocol,com.microsoft.azure.sdk.iot.service.ProxyOptions,javax.net.ssl.SSLContext)"
fullName: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, ProxyOptions proxyOptions, SSLContext sslContext)"
name: "FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, ProxyOptions proxyOptions, SSLContext sslContext)"
nameWithType: "FeedbackReceiver.FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, ProxyOptions proxyOptions, SSLContext sslContext)"
summary: "Constructor to verify initialization parameters Create instance of Amqp<wbr>Receive"
parameters:
- description: "The iot hub host name"
name: "hostName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The iot hub user name"
name: "userName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The iot hub SAS token for the given device"
name: "sasToken"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "protocol to be used"
name: "iotHubServiceClientProtocol"
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.IotHubServiceClientProtocol?alt=com.microsoft.azure.sdk.iot.service.IotHubServiceClientProtocol&text=IotHubServiceClientProtocol\" data-throw-if-not-resolved=\"False\" />"
- description: "the proxy options to tunnel through, if a proxy should be used."
name: "proxyOptions"
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.ProxyOptions?alt=com.microsoft.azure.sdk.iot.service.ProxyOptions&text=ProxyOptions\" data-throw-if-not-resolved=\"False\" />"
- description: "the SSL context to use during the TLS handshake when opening the connection. If null, a default\n SSL context will be generated. This default SSLContext trusts the IoT Hub public certificates."
name: "sslContext"
type: "<xref href=\"javax.net.ssl.SSLContext?alt=javax.net.ssl.SSLContext&text=SSLContext\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, ProxyOptions proxyOptions, SSLContext sslContext)"
desc: "Constructor to verify initialization parameters Create instance of AmqpReceive"
- uid: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.FeedbackReceiver(java.lang.String,java.lang.String,java.lang.String,com.microsoft.azure.sdk.iot.service.IotHubServiceClientProtocol,java.lang.String)"
fullName: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, String deviceId)"
name: "FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, String deviceId)"
nameWithType: "FeedbackReceiver.FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, String deviceId)"
summary: "Constructor to verify initialization parameters Create instance of Amqp<wbr>Receive"
deprecatedTag: "As of release 1.1.15, replaced by <xref uid=\"com.microsoft.azure.sdk.iot.service.FeedbackReceiver.FeedbackReceiver(java.lang.String,java.lang.String,java.lang.String,com.microsoft.azure.sdk.iot.service.IotHubServiceClientProtocol)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol)\"></xref>"
parameters:
- description: "The iot hub host name"
name: "hostName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The iot hub user name"
name: "userName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The iot hub SAS token for the given device"
name: "sasToken"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The iot hub protocol name"
name: "iotHubServiceClientProtocol"
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.IotHubServiceClientProtocol?alt=com.microsoft.azure.sdk.iot.service.IotHubServiceClientProtocol&text=IotHubServiceClientProtocol\" data-throw-if-not-resolved=\"False\" />"
- description: "The device id (not used)"
name: "deviceId"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "</br>public FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, String deviceId)"
desc: "Constructor to verify initialization parameters Create instance of AmqpReceive"
hasDeprecatedTag: true
methods:
- uid: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.close()"
fullName: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.close()"
name: "close()"
nameWithType: "FeedbackReceiver.close()"
summary: "Close Amqp<wbr>Receive object"
syntax: "public void close()"
exceptions:
- description: "This exception is thrown if the input AmqpReceive object is null"
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
desc: "Close AmqpReceive object"
- uid: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.closeAsync()"
fullName: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.closeAsync()"
name: "closeAsync()"
nameWithType: "FeedbackReceiver.closeAsync()"
summary: "Async wrapper for close() operation"
overridden: "com.microsoft.azure.sdk.iot.service.Receiver.closeAsync()"
syntax: "public CompletableFuture<Void> closeAsync()"
desc: "Async wrapper for close() operation"
returns:
description: "The future object for the requested operation"
type: "<xref href=\"java.util.concurrent.CompletableFuture?alt=java.util.concurrent.CompletableFuture&text=CompletableFuture\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.Void?alt=java.lang.Void&text=Void\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.open()"
fullName: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.open()"
name: "open()"
nameWithType: "FeedbackReceiver.open()"
summary: "Open Amqp<wbr>Receive object"
syntax: "public void open()"
exceptions:
- description: "This exception is thrown if the input AmqpReceive object is null"
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
desc: "Open AmqpReceive object"
- uid: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.openAsync()"
fullName: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.openAsync()"
name: "openAsync()"
nameWithType: "FeedbackReceiver.openAsync()"
summary: "Async wrapper for open() operation"
overridden: "com.microsoft.azure.sdk.iot.service.Receiver.openAsync()"
syntax: "public CompletableFuture<Void> openAsync()"
desc: "Async wrapper for open() operation"
returns:
description: "The future object for the requested operation"
type: "<xref href=\"java.util.concurrent.CompletableFuture?alt=java.util.concurrent.CompletableFuture&text=CompletableFuture\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.Void?alt=java.lang.Void&text=Void\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.receive()"
fullName: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.receive()"
name: "receive()"
nameWithType: "FeedbackReceiver.receive()"
summary: "Receive Feedback<wbr>Batch with default timeout This function is synchronized internally so that only one receive operation is allowed at a time."
syntax: "public FeedbackBatch receive()"
exceptions:
- description: "This exception is thrown if the input AmqpReceive object is null"
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
- description: "This exception is thrown if the input AmqpReceive object is null"
type: "<xref href=\"java.lang.InterruptedException?alt=java.lang.InterruptedException&text=InterruptedException\" data-throw-if-not-resolved=\"False\" />"
desc: "Receive FeedbackBatch with default timeout This function is synchronized internally so that only one receive operation is allowed at a time. In order to do more receive operations at a time, you will need to instantiate another FeedbackReceiver instance."
returns:
description: "The received FeedbackBatch object"
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.FeedbackBatch?alt=com.microsoft.azure.sdk.iot.service.FeedbackBatch&text=FeedbackBatch\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.receive(long)"
fullName: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.receive(long timeoutMs)"
name: "receive(long timeoutMs)"
nameWithType: "FeedbackReceiver.receive(long timeoutMs)"
summary: "Receive Feedback<wbr>Batch with specific timeout This function is synchronized internally so that only one receive operation is allowed at a time."
parameters:
- description: "The timeout in milliseconds"
name: "timeoutMs"
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FeedbackBatch receive(long timeoutMs)"
exceptions:
- description: "This exception is thrown if the input AmqpReceive object is null"
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
- description: "This exception is thrown if the input AmqpReceive object is null"
type: "<xref href=\"java.lang.InterruptedException?alt=java.lang.InterruptedException&text=InterruptedException\" data-throw-if-not-resolved=\"False\" />"
desc: "Receive FeedbackBatch with specific timeout This function is synchronized internally so that only one receive operation is allowed at a time. In order to do more receive operations at a time, you will need to instantiate another FeedbackReceiver instance."
returns:
description: "The received FeedbackBatch object"
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.FeedbackBatch?alt=com.microsoft.azure.sdk.iot.service.FeedbackBatch&text=FeedbackBatch\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.receiveAsync()"
fullName: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.receiveAsync()"
name: "receiveAsync()"
nameWithType: "FeedbackReceiver.receiveAsync()"
summary: "Async wrapper for receive() operation with default timeout"
overridden: "com.microsoft.azure.sdk.iot.service.Receiver.receiveAsync()"
syntax: "public CompletableFuture<FeedbackBatch> receiveAsync()"
desc: "Async wrapper for receive() operation with default timeout"
returns:
description: "The future object for the requested operation"
type: "<xref href=\"java.util.concurrent.CompletableFuture?alt=java.util.concurrent.CompletableFuture&text=CompletableFuture\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.sdk.iot.service.FeedbackBatch?alt=com.microsoft.azure.sdk.iot.service.FeedbackBatch&text=FeedbackBatch\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.receiveAsync(long)"
fullName: "com.microsoft.azure.sdk.iot.service.FeedbackReceiver.receiveAsync(long timeoutMs)"
name: "receiveAsync(long timeoutMs)"
nameWithType: "FeedbackReceiver.receiveAsync(long timeoutMs)"
summary: "Async wrapper for receive() operation with specific timeout"
overridden: "com.microsoft.azure.sdk.iot.service.Receiver.receiveAsync(long)"
parameters:
- name: "timeoutMs"
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CompletableFuture<FeedbackBatch> receiveAsync(long timeoutMs)"
desc: "Async wrapper for receive() operation with specific timeout"
returns:
description: "The future object for the requested operation"
type: "<xref href=\"java.util.concurrent.CompletableFuture?alt=java.util.concurrent.CompletableFuture&text=CompletableFuture\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.sdk.iot.service.FeedbackBatch?alt=com.microsoft.azure.sdk.iot.service.FeedbackBatch&text=FeedbackBatch\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "class"
desc: "FeedbackReceiver is a specialized receiver whose ReceiveAsync method returns a FeedbackBatch instead of a Message."
metadata: {}
package: "com.microsoft.azure.sdk.iot.service"
artifact: com.microsoft.azure.sdk.iot:iot-service-client:1.30.0