114 строки
7.9 KiB
YAML
114 строки
7.9 KiB
YAML
### YamlMime:JavaType
|
|
constructors:
|
|
- fullName: com.microsoft.azure.servicebus.MessageHandlerOptions.MessageHandlerOptions()
|
|
name: MessageHandlerOptions()
|
|
nameWithType: MessageHandlerOptions.MessageHandlerOptions()
|
|
summary: <p>Default constructor for create <xref uid="com.microsoft.azure.servicebus.MessageHandlerOptions" data-throw-if-not-resolved="false" data-raw-source="MessageHandlerOptions"></xref> with default settings. <xref uid="com.microsoft.azure.servicebus.MessageHandlerOptions.getMaxConcurrentCalls()" data-throw-if-not-resolved="false" data-raw-source="MessageHandlerOptions#getMaxConcurrentCalls()"></xref> default value is 1. <xref uid="com.microsoft.azure.servicebus.MessageHandlerOptions.getMaxAutoRenewDuration()" data-throw-if-not-resolved="false" data-raw-source="MessageHandlerOptions#getMaxAutoRenewDuration()"></xref> default value is 5 minutes. <xref uid="com.microsoft.azure.servicebus.MessageHandlerOptions.isAutoComplete()" data-throw-if-not-resolved="false" data-raw-source="MessageHandlerOptions#isAutoComplete()"></xref> default is true. </p>
|
|
syntax: public MessageHandlerOptions()
|
|
uid: com.microsoft.azure.servicebus.MessageHandlerOptions.MessageHandlerOptions()
|
|
- fullName: com.microsoft.azure.servicebus.MessageHandlerOptions.MessageHandlerOptions(int maxConcurrentCalls, boolean autoComplete, Duration maxAutoRenewDuration)
|
|
name: MessageHandlerOptions(int maxConcurrentCalls, boolean autoComplete, Duration maxAutoRenewDuration)
|
|
nameWithType: MessageHandlerOptions.MessageHandlerOptions(int maxConcurrentCalls, boolean autoComplete, Duration maxAutoRenewDuration)
|
|
parameters:
|
|
- description: <p>maximum number of concurrent calls to the onMessage handler </p>
|
|
name: maxConcurrentCalls
|
|
type: <xref href="int?alt=int&text=int" data-throw-if-not-resolved="False"/>
|
|
- description: <p>true if the pump should automatically complete message after onMessageHandler action is completed. false otherwise. </p>
|
|
name: autoComplete
|
|
type: <xref href="boolean?alt=boolean&text=boolean" data-throw-if-not-resolved="False"/>
|
|
- description: <p>- Maximum duration within which the client keeps renewing the message lock if the processing of the message is not completed by the handler. </p>
|
|
name: maxAutoRenewDuration
|
|
type: <xref href="Duration?alt=Duration&text=Duration" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Create a instance of <xref uid="com.microsoft.azure.servicebus.MessageHandlerOptions" data-throw-if-not-resolved="false" data-raw-source="MessageHandlerOptions"></xref>.</p>
|
|
|
|
<p></p>
|
|
syntax: public MessageHandlerOptions(int maxConcurrentCalls, boolean autoComplete, Duration maxAutoRenewDuration)
|
|
uid: com.microsoft.azure.servicebus.MessageHandlerOptions.MessageHandlerOptions(int,boolean,Duration)
|
|
- fullName: com.microsoft.azure.servicebus.MessageHandlerOptions.MessageHandlerOptions(int maxConcurrentCalls, boolean autoComplete, Duration maxAutoRenewDuration, Duration messageWaitDuration)
|
|
name: MessageHandlerOptions(int maxConcurrentCalls, boolean autoComplete, Duration maxAutoRenewDuration, Duration messageWaitDuration)
|
|
nameWithType: MessageHandlerOptions.MessageHandlerOptions(int maxConcurrentCalls, boolean autoComplete, Duration maxAutoRenewDuration, Duration messageWaitDuration)
|
|
parameters:
|
|
- description: <p>maximum number of concurrent calls to the onMessage handler </p>
|
|
name: maxConcurrentCalls
|
|
type: <xref href="int?alt=int&text=int" data-throw-if-not-resolved="False"/>
|
|
- description: <p>true if the pump should automatically complete message after onMessageHandler action is completed. false otherwise. </p>
|
|
name: autoComplete
|
|
type: <xref href="boolean?alt=boolean&text=boolean" data-throw-if-not-resolved="False"/>
|
|
- description: <p>- Maximum duration within which the client keeps renewing the message lock if the processing of the message is not completed by the handler. </p>
|
|
name: maxAutoRenewDuration
|
|
type: <xref href="Duration?alt=Duration&text=Duration" data-throw-if-not-resolved="False"/>
|
|
- description: <p>duration to wait for receiving the message </p>
|
|
name: messageWaitDuration
|
|
type: <xref href="Duration?alt=Duration&text=Duration" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Create a instance of <xref uid="com.microsoft.azure.servicebus.MessageHandlerOptions" data-throw-if-not-resolved="false" data-raw-source="MessageHandlerOptions"></xref>.</p>
|
|
|
|
<p></p>
|
|
syntax: public MessageHandlerOptions(int maxConcurrentCalls, boolean autoComplete, Duration maxAutoRenewDuration, Duration messageWaitDuration)
|
|
uid: com.microsoft.azure.servicebus.MessageHandlerOptions.MessageHandlerOptions(int,boolean,Duration,Duration)
|
|
inheritances:
|
|
- <xref href="java.lang.Object" data-throw-if-not-resolved="False"/>
|
|
methods:
|
|
- fullName: com.microsoft.azure.servicebus.MessageHandlerOptions.getMaxAutoRenewDuration()
|
|
name: getMaxAutoRenewDuration()
|
|
nameWithType: MessageHandlerOptions.getMaxAutoRenewDuration()
|
|
returns:
|
|
description: <p>The maximum duration during which locks are automatically renewed. </p>
|
|
type: <xref href="Duration?alt=Duration&text=Duration" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Gets the maximum duration within which the lock will be renewed automatically. This value should be greater than the longest message lock duration; for example, the LockDuration Property.</p>
|
|
|
|
<p></p>
|
|
syntax: public Duration getMaxAutoRenewDuration()
|
|
uid: com.microsoft.azure.servicebus.MessageHandlerOptions.getMaxAutoRenewDuration()
|
|
- fullName: com.microsoft.azure.servicebus.MessageHandlerOptions.getMaxConcurrentCalls()
|
|
name: getMaxConcurrentCalls()
|
|
nameWithType: MessageHandlerOptions.getMaxConcurrentCalls()
|
|
returns:
|
|
description: <p>The maximum number of concurrent calls to the callback. </p>
|
|
type: <xref href="int?alt=int&text=int" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Gets the maximum number of concurrent calls to the callback the message pump should initiate.</p>
|
|
|
|
<p></p>
|
|
syntax: public int getMaxConcurrentCalls()
|
|
uid: com.microsoft.azure.servicebus.MessageHandlerOptions.getMaxConcurrentCalls()
|
|
- fullName: com.microsoft.azure.servicebus.MessageHandlerOptions.getMessageWaitDuration()
|
|
name: getMessageWaitDuration()
|
|
nameWithType: MessageHandlerOptions.getMessageWaitDuration()
|
|
returns:
|
|
description: <p>The wait duration for receive calls. </p>
|
|
type: <xref href="Duration?alt=Duration&text=Duration" data-throw-if-not-resolved="False"/>
|
|
summary: <p>Gets the time to wait for receiving a message. Defaults to 1 minute. </p>
|
|
syntax: public Duration getMessageWaitDuration()
|
|
uid: com.microsoft.azure.servicebus.MessageHandlerOptions.getMessageWaitDuration()
|
|
- fullName: com.microsoft.azure.servicebus.MessageHandlerOptions.isAutoComplete()
|
|
name: isAutoComplete()
|
|
nameWithType: MessageHandlerOptions.isAutoComplete()
|
|
returns:
|
|
description: <p>true to complete the message processing automatically on successful execution of the operation; otherwise, false. </p>
|
|
type: <xref href="boolean?alt=boolean&text=boolean" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Whether the auto complete is set to true.</p>
|
|
|
|
<p></p>
|
|
syntax: public boolean isAutoComplete()
|
|
uid: com.microsoft.azure.servicebus.MessageHandlerOptions.isAutoComplete()
|
|
- fullName: com.microsoft.azure.servicebus.MessageHandlerOptions.toString()
|
|
name: toString()
|
|
nameWithType: MessageHandlerOptions.toString()
|
|
returns:
|
|
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
|
syntax: public String toString()
|
|
uid: com.microsoft.azure.servicebus.MessageHandlerOptions.toString()
|
|
nameWithType: MessageHandlerOptions
|
|
syntax: public class MessageHandlerOptions
|
|
type: class
|
|
uid: com.microsoft.azure.servicebus.MessageHandlerOptions
|
|
fullName: com.microsoft.azure.servicebus.MessageHandlerOptions
|
|
name: MessageHandlerOptions
|
|
package: com.microsoft.azure.servicebus
|
|
summary: <p>The OnMessage handler processing options. </p>
|
|
metadata: {}
|