FabricClientSettings Class

Package:

system.fabric

• java.lang.Object
• • system.fabric.FabricClientSettings

public class FabricClientSettings

Represents the configuration settings for the FabricClient class.

Constructor Summary

Constructor	Description
FabricClientSettings()	Creates an Instance of system.fabric.FabricClientSettings

Method Summary

Modifier and Type	Method and Description
String	getClientFriendlyName() Gets the client friendly name that will appear in Service Fabric traces for debugging. Remarks: The default value is null and the client friendly name will automatically be generated as a UUID internally.
Duration	getConnectionInitializationTimeout() Gets the timeout after which, if the current gateway address does not respond with a valid connection, another different address is randomly selected from the gateway addresses collection. Remarks:The default value of this property is 2 seconds. This property must be less than the value of the getServiceChangePollInterval() property.
Duration	getHealthOperationTimeout() Gets the timeout on health operation requests from the client to the gateway. Remarks:The default value of this property is 120 seconds.
Duration	getHealthReportRetrySendInterval() Gets the retry interval at which health reports that have not yet been acknowledged by the Health Manager are resent. Remarks:The default value of this property is 30 seconds.
Duration	getHealthReportSendInterval() Gets the interval at which health reports are sent to Health Manager. Remarks:The default value of this property is 30 seconds.
Duration	getKeepAliveInterval() Gets the interval at which the FabricClient will ping the connected endpoint. Remarks:The default value of this property is 0 seconds. This property can't be updated after the FabricClient is opened. Setting this property will throw a java.lang.IllegalArgumentException exception. FabricClient will continue pinging as long as it has pending operations.
Duration	getNotificationCacheUpdateTimeout() Gets the timeout for updating the local cache in response to service notifications. The default value is 30 seconds.
Duration	getNotificationGatewayConnectionTimeout() Gets the timeout for running a re-connection protocol if the client has registered for service notifications. The default value is 30 seconds.
long	getPartitionLocationCacheBucketCount() Gets the bucket count used by the client’s service resolution cache. Remarks:The default value is 1024.
long	getPartitionLocationCacheLimit() Gets the maximum number of cached location entries on the client. Remarks:The default value of this property is 1000. This property is not updatable. Setting this property will throw a java.lang.IllegalArgumentException exception. When the cache limit is reached the oldest entries are discarded first. The default value is 100.
Duration	getServiceChangePollInterval() Gets the timeout on service change notification requests from the client to the gateway for all registered callbacks. Remarks:The default value of this property is 120 seconds.
void	setClientFriendlyName(String clientFriendlyName) Sets the client friendly name that will appear in Service Fabric traces for debugging. Remarks: The default value is null and the client friendly name will automatically be generated as a UUID internally.
void	setConnectionInitializationTimeout(Duration connectionInitializationTimeout) Sets the timeout after which, if the current gateway address does not respond with a valid connection, another different address is randomly selected from the gateway addresses collection. Remarks:The default value of this property is 2 seconds. This property must be less than the value of the getServiceChangePollInterval() property.
void	setHealthOperationTimeout(Duration healthOperationTimeout) Sets the timeout on health operation requests from the client to the gateway. Remarks:The default value of this property is 120 seconds.
void	setHealthReportRetrySendInterval(Duration healthReportRetrySendInterval) Sets the retry interval at which health reports that have not yet been acknowledged by the Health Manager are resent. Remarks:The default value of this property is 30 seconds.
void	setHealthReportSendInterval(Duration healthReportSendInterval) Sets the interval at which health reports are sent to Health Manager. Remarks:The default value of this property is 30 seconds.
void	setKeepAliveInterval(Duration keepAliveInterval) Sets the interval at which the FabricClient will ping the connected endpoint. Remarks:The default value of this property is 0 seconds. This property can't be updated after the FabricClient is opened. Setting this property will throw a java.lang.IllegalArgumentException exception. FabricClient will continue pinging as long as it has pending operations.
void	setNotificationCacheUpdateTimeout(Duration notificationCacheUpdateTimeout) Sets the timeout for updating the local cache in response to service notifications. The default value is 30 seconds.
void	setNotificationGatewayConnectionTimeout(Duration notificationGatewayConnectionTimeout) Sets the timeout for running a re-connection protocol if the client has registered for service notifications. The default value is 30 seconds.
void	setPartitionLocationCacheBucketCount(long partitionLocationCacheBucketCount) Sets the bucket count used by the client’s service resolution cache. Remarks:The default value is 1024.
void	setPartitionLocationCacheLimit(long partitionLocationCacheLimit) Sets the maximum number of cached location entries on the client. Remarks:The default value of this property is 1000. This property is not updatable. Setting this property will throw a java.lang.IllegalArgumentException exception. When the cache limit is reached the oldest entries are discarded first. The default value is 100.
void	setServiceChangePollInterval(Duration serviceChangePollInterval) Sets the timeout on service change notification requests from the client to the gateway for all registered callbacks. Remarks:The default value of this property is 120 seconds.

Constructor Details

FabricClientSettings

public FabricClientSettings()

Creates an Instance of system.fabric.FabricClientSettings

Method Details

getClientFriendlyName

public String getClientFriendlyName()

Gets the client friendly name that will appear in Service Fabric traces for debugging.

Remarks: The default value is null and the client friendly name will automatically be generated as a UUID internally.

Returns:

The client friendly name that will appear in Service Fabric traces for debugging.

getConnectionInitializationTimeout

public Duration getConnectionInitializationTimeout()

Gets the timeout after which, if the current gateway address does not respond with a valid connection, another different address is randomly selected from the gateway addresses collection.

Remarks:The default value of this property is 2 seconds. This property must be less than the value of the getServiceChangePollInterval() property.

Returns:

The timeout after the current gateway address does not respond with a valid connection.

getHealthOperationTimeout

public Duration getHealthOperationTimeout()

Gets the timeout on health operation requests from the client to the gateway.

Remarks:The default value of this property is 120 seconds.

Returns:

The timeout on health operation requests from the client to the gateway.

getHealthReportRetrySendInterval

public Duration getHealthReportRetrySendInterval()

Gets the retry interval at which health reports that have not yet been acknowledged by the Health Manager are resent.

Remarks:The default value of this property is 30 seconds.

Returns:

The retry interval at which health reports that have not yet been acknowledged by the Health Manager are resent.

getHealthReportSendInterval

public Duration getHealthReportSendInterval()

Gets the interval at which health reports are sent to Health Manager.

Remarks:The default value of this property is 30 seconds.

Returns:

The interval at which health reports are sent to Health Manager.

getKeepAliveInterval

public Duration getKeepAliveInterval()

Gets the interval at which the FabricClient will ping the connected endpoint.

Remarks:The default value of this property is 0 seconds. This property can't be updated after the FabricClient is opened. Setting this property will throw a java.lang.IllegalArgumentException exception. FabricClient will continue pinging as long as it has pending operations.

Returns:

The interval at which the FabricClient will ping the connected endpoint.

getNotificationCacheUpdateTimeout

public Duration getNotificationCacheUpdateTimeout()

Gets the timeout for updating the local cache in response to service notifications. The default value is 30 seconds.

Returns:

The timeout for updating the local cache in response to service notifications.

getNotificationGatewayConnectionTimeout

public Duration getNotificationGatewayConnectionTimeout()

Gets the timeout for running a re-connection protocol if the client has registered for service notifications. The default value is 30 seconds.

Returns:

The timeout for running a re-connection protocol if the client has registered for service notifications.

getPartitionLocationCacheBucketCount

public long getPartitionLocationCacheBucketCount()

Gets the bucket count used by the client’s service resolution cache.

Remarks:The default value is 1024.

Returns:

The bucket count used by the client’s service resolution cache.

getPartitionLocationCacheLimit

public long getPartitionLocationCacheLimit()

Gets the maximum number of cached location entries on the client.

Remarks:The default value of this property is 1000. This property is not updatable. Setting this property will throw a java.lang.IllegalArgumentException exception. When the cache limit is reached the oldest entries are discarded first. The default value is 100.

Returns:

The maximum number of cached location entries on the client.

getServiceChangePollInterval

public Duration getServiceChangePollInterval()

Gets the timeout on service change notification requests from the client to the gateway for all registered callbacks.

Remarks:The default value of this property is 120 seconds.

Returns:

The timeout on service change notification requests from the client to the gateway for all registered callbacks.

setClientFriendlyName

public void setClientFriendlyName(String clientFriendlyName)

Sets the client friendly name that will appear in Service Fabric traces for debugging.

Remarks: The default value is null and the client friendly name will automatically be generated as a UUID internally.

Parameters:

clientFriendlyName - The client friendly name that will appear in Service Fabric traces for debugging.

setConnectionInitializationTimeout

public void setConnectionInitializationTimeout(Duration connectionInitializationTimeout)

Sets the timeout after which, if the current gateway address does not respond with a valid connection, another different address is randomly selected from the gateway addresses collection.

Remarks:The default value of this property is 2 seconds. This property must be less than the value of the getServiceChangePollInterval() property.

Parameters:

connectionInitializationTimeout - The timeout after the current gateway address does not respond with a valid connection.

setHealthOperationTimeout

public void setHealthOperationTimeout(Duration healthOperationTimeout)

Sets the timeout on health operation requests from the client to the gateway.

Remarks:The default value of this property is 120 seconds.

Parameters:

healthOperationTimeout - The timeout on health operation requests from the client to the gateway.

setHealthReportRetrySendInterval

public void setHealthReportRetrySendInterval(Duration healthReportRetrySendInterval)

Sets the retry interval at which health reports that have not yet been acknowledged by the Health Manager are resent.

Remarks:The default value of this property is 30 seconds.

Parameters:

healthReportRetrySendInterval - The retry interval at which health reports that have not yet been acknowledged by the Health Manager are resent.

setHealthReportSendInterval

public void setHealthReportSendInterval(Duration healthReportSendInterval)

Sets the interval at which health reports are sent to Health Manager.

Remarks:The default value of this property is 30 seconds.

Parameters:

healthReportSendInterval - The interval at which health reports are sent to Health Manager.

setKeepAliveInterval

public void setKeepAliveInterval(Duration keepAliveInterval)

Sets the interval at which the FabricClient will ping the connected endpoint.

Remarks:The default value of this property is 0 seconds. This property can't be updated after the FabricClient is opened. Setting this property will throw a java.lang.IllegalArgumentException exception. FabricClient will continue pinging as long as it has pending operations.

Parameters:

keepAliveInterval - The interval at which the FabricClient will ping the connected endpoint.

setNotificationCacheUpdateTimeout

public void setNotificationCacheUpdateTimeout(Duration notificationCacheUpdateTimeout)

Sets the timeout for updating the local cache in response to service notifications. The default value is 30 seconds.

Parameters:

notificationCacheUpdateTimeout - The timeout for updating the local cache in response to service notifications.

setNotificationGatewayConnectionTimeout

public void setNotificationGatewayConnectionTimeout(Duration notificationGatewayConnectionTimeout)

Sets the timeout for running a re-connection protocol if the client has registered for service notifications. The default value is 30 seconds.

Parameters:

notificationGatewayConnectionTimeout - The timeout for running a re-connection protocol if the client has registered for service notifications.

setPartitionLocationCacheBucketCount

public void setPartitionLocationCacheBucketCount(long partitionLocationCacheBucketCount)

Sets the bucket count used by the client’s service resolution cache.

Remarks:The default value is 1024.

Parameters:

partitionLocationCacheBucketCount - The bucket count used by the client’s service resolution cache.

setPartitionLocationCacheLimit

public void setPartitionLocationCacheLimit(long partitionLocationCacheLimit)

Sets the maximum number of cached location entries on the client.

Remarks:The default value of this property is 1000. This property is not updatable. Setting this property will throw a java.lang.IllegalArgumentException exception. When the cache limit is reached the oldest entries are discarded first. The default value is 100.

Parameters:

partitionLocationCacheLimit - The maximum number of cached location entries on the client.

setServiceChangePollInterval

public void setServiceChangePollInterval(Duration serviceChangePollInterval)

Sets the timeout on service change notification requests from the client to the gateway for all registered callbacks.

Remarks:The default value of this property is 120 seconds.

Parameters:

serviceChangePollInterval - The timeout on service change notification requests from the client to the gateway for all registered callbacks.