FabricTransportRemotingSettings Class
Definition
- java.lang.Object
- microsoft.servicefabric.services.remoting.fabrictransport.FabricTransportRemotingSettings
Settings that configures the FabricTransport communication.
public class FabricTransportRemotingSettingsConstructors
| FabricTransportRemotingSettings() |
Creates a new FabricTransportRemotingSettings with default Values. |
Methods
| getConnectTimeout() |
Connect timeout specifies the maximum time allowed for the connection to be established successfully.
Remarks:Default Value for ConnectTimeout Timeout is set as 5 seconds. |
| getDefault() |
FabricTransportSettings returns the default Settings .Loads the configuration file from default Config Package"Config" , if not found then try to load from default config file "ClientExeName.Settings.xml" from Client Exe directory. |
| getDefault(String sectionName) |
FabricTransportSettings returns the default Settings .Loads the configuration file from default Config Package"Config" , if not found then try to load from default config file "ClientExeName.Settings.xml" from Client Exe directory. |
| getInternalSettings() | |
| getKeepAliveTimeout() |
KeepAliveTimeout is provides a way to configure Tcp keep-alive option.
Remarks:Default Value for KeepAliveTimeout Timeout is set as TimeSpan.Zero. which indicates we disable the tcp keepalive option. If you are using loadbalancer , you may need to configure this in order to avoid the loadbalancer to close the connection after certain time |
| getMaxConcurrentCalls() |
MaxConcurrentCalls represents maximum number of messages actively service processes at one time.
Remarks:Defaults value for the MaxConcurrentCalls is to the Number of processors. |
| getMaxMessageSize() |
MaxMessageSize represents the maximum size for a message that can be received on a channel configured with this setting.
Remarks:Default Value for MaxMessageSize used is 4194304 bytes |
| getMaxQueueSize() |
The maximum size, of a queue that stores messages while they are processed for an endpoint configured with this setting.
Remarks:Default value is 10,000 messages |
| getOperationTimeout() |
Operation Timeout which governs the whole process of sending a message, including receiving a reply message for a request/reply service operation. This timeout also applies when sending reply messages from a callback contract method.
Remarks:Default Value for Operation Timeout is set as 5 mins |
| getSecurityCredentials() |
Security credentials for securing the communication
Remarks:Default Value for SecurityCredentials is None SecurityCredential can be of type x509SecurityCredentail X509Credentialsor WindowsCredentials WindowsCredentials |
| loadFrom(String sectionName) |
Loads the FabricTransport settings from a sectionName specified in the configuration file Configuration File can be specified using the filePath or using the name of the configuration package specified in the service manifest . It will first try to load config using configPackageName . if configPackageName is not specified then try to load from filePath.
Remarks: The following are the parameter names that should be provided in the configuration file,to be recognizable by service fabric to load the transport settings. 1. MaxQueueSize - value in long. 2. MaxMessageSize - value in bytes. 3. MaxConcurrentCalls - value in long. 4. SecurityCredentials - SecurityCredentials value. 5. OperationTimeoutInSeconds - value in seconds. 6. KeepAliveTimeoutInSeconds
|
| loadFromConfigPackage(String sectionName, String configPackageName) |
Loads the FabricTransport settings from a sectionName specified in the configuration file Configuration File can be specified using the filePath or using the name of the configuration package specified in the service manifest . It will first try to load config using configPackageName . if configPackageName is not specified then try to load from filePath.
Remarks: The following are the parameter names that should be provided in the configuration file,to be recognizable by service fabric to load the transport settings. 1. MaxQueueSize - value in long. 2. MaxMessageSize - value in bytes. 3. MaxConcurrentCalls - value in long. 4. SecurityCredentials - SecurityCredentials value. 5. OperationTimeoutInSeconds - value in seconds. 6. KeepAliveTimeoutInSeconds
|
| loadFromFile(String sectionName, String filePath) |
Loads the FabricTransport settings from a sectionName specified in the configuration file Configuration File can be specified using the filePath or using the name of the configuration package specified in the service manifest . It will first try to load config using configPackageName . if configPackageName is not specified then try to load from filePath.
Remarks: The following are the parameter names that should be provided in the configuration file,to be recognizable by service fabric to load the transport settings. 1. MaxQueueSize - value in long. 2. MaxMessageSize - value in bytes. 3. MaxConcurrentCalls - value in long. 4. SecurityCredentials - SecurityCredentials value. 5. OperationTimeoutInSeconds - value in seconds. 6. KeepAliveTimeoutInSeconds
|
| setConnectTimeout(Duration connectTimeout) |
Connect timeout specifies the maximum time allowed for the connection to be established successfully.
Remarks:Default Value for ConnectTimeout Timeout is set as 5 seconds. |
| setKeepAliveTimeout(Duration keepAliveTimeout) |
KeepAliveTimeout is provides a way to configure Tcp keep-alive option.
Remarks:Default Value for KeepAliveTimeout Timeout is set as TimeSpan.Zero. which indicates we disable the tcp keepalive option. If you are using loadbalancer , you may need to configure this in order to avoid the loadbalancer to close the connection after certain time |
| setMaxConcurrentCalls(Long maxConcurrentCalls) |
MaxConcurrentCalls represents maximum number of messages actively service processes at one time.
Remarks:Defaults value for the MaxConcurrentCalls is to the Number of processors. |
| setMaxMessageSize(Long maxMessageSize) |
MaxMessageSize represents the maximum size for a message that can be received on a channel configured with this setting.
Remarks:Default Value for MaxMessageSize used is 4194304 bytes |
| setMaxQueueSize(Long maxQueueSize) |
The maximum size, of a queue that stores messages while they are processed for an endpoint configured with this setting.
Remarks:Default value is 10,000 messages |
| setOperationTimeout(Duration operationTimeout) |
Operation Timeout which governs the whole process of sending a message, including receiving a reply message for a request/reply service operation. This timeout also applies when sending reply messages from a callback contract method.
Remarks:Default Value for Operation Timeout is set as 5 mins |
| setSecurityCredentials(SecurityCredentials securityCredentials) |
Security credentials for securing the communication
Remarks:Default Value for SecurityCredentials is None SecurityCredential can be of type x509SecurityCredentail X509Credentials or WindowsCredentials WindowsCredentials |
| tryLoadFrom(String sectionName) |
Try to load the FabricTransport settings from a sectionName specified in the configuration file. Configuration File can be specified using the filePath or using the name of the configuration package specified in the service manifest . It will first try to load config using configPackageName . if configPackageName is not specified then try to load from filePath.
Remarks:The following are the parameter names that should be provided in the configuration file,to be recognizable by service fabric to load the transport settings. 1. MaxQueueSize - value in long. 2. MaxMessageSize - value in bytes. 3. MaxConcurrentCalls - value in long. 4. SecurityCredentials - SecurityCredentials value. 5. OperationTimeoutInSeconds - value in seconds. 6. KeepAliveTimeoutInSeconds
|
| tryLoadFromConfigPackage(String sectionName, String configPackageName) |
Try to load the FabricTransport settings from a sectionName specified in the configuration file. Configuration File can be specified using the filePath or using the name of the configuration package specified in the service manifest . It will first try to load config using configPackageName . if configPackageName is not specified then try to load from filePath.
Remarks:The following are the parameter names that should be provided in the configuration file,to be recognizable by service fabric to load the transport settings. 1. MaxQueueSize - value in long. 2. MaxMessageSize - value in bytes. 3. MaxConcurrentCalls - value in long. 4. SecurityCredentials - SecurityCredentials value. 5. OperationTimeoutInSeconds - value in seconds. 6. KeepAliveTimeoutInSeconds
|
| tryLoadFromFile(String sectionName, String filePath) |
Try to load the FabricTransport settings from a sectionName specified in the configuration file. Configuration File can be specified using the filePath or using the name of the configuration package specified in the service manifest . It will first try to load config using configPackageName . if configPackageName is not specified then try to load from filePath.
Remarks:The following are the parameter names that should be provided in the configuration file,to be recognizable by service fabric to load the transport settings. 1. MaxQueueSize - value in long. 2. MaxMessageSize - value in bytes. 3. MaxConcurrentCalls - value in long. 4. SecurityCredentials - SecurityCredentials value. 5. OperationTimeoutInSeconds - value in seconds. 6. KeepAliveTimeoutInSeconds
|