FabricTransportServiceRemotingProvider Class

Package:

microsoft.servicefabric.services.remoting.fabrictransport

• java.lang.Object
• • ServiceRemotingProvider
  • • microsoft.servicefabric.services.remoting.fabrictransport.FabricTransportServiceRemotingProvider

public class FabricTransportServiceRemotingProvider extends ServiceRemotingProvider

Sets Fabric TCP transport as the default service remoting transport provider in the assembly.

Method Summary

Modifier and Type	Method and Description
ServiceRemotingClientFactory	createServiceRemotingClientFactory(ServiceRemotingCallbackClient callbackClient) Creates a service remoting client factory for connecting to the service over remoted service interfaces.
ServiceRemotingListener	createServiceRemotingListener(ServiceContext serviceContext, Service serviceImplementation) Creates a service remoting listener for remoting the service interface.
long	getConnectTimeoutInMilliseconds() Gets the connect timeout in milliseconds. This settings specifies the maximum time allowed for the connection to be established.
long	getKeepAliveTimeoutInSeconds() Gets the keepAliveTimeoutInSeconds that provides a way to configure Tcp keep-alive option.
long	getMaxMessageSize() Gets the maximum size for a message that can be received on a channel configured with this setting.
long	getOperationTimeoutInSeconds() Gets the 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.
void	setConnectTimeoutInMilliseconds(long connectTimeoutInMilliseconds) Sets the connect timeout in milliseconds. This settings specifies the maximum time allowed for the connection to be established.
void	setKeepAliveTimeoutInSeconds(long keepAliveTimeoutInSeconds) Sets the keepAliveTimeoutInSeconds that 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.
void	setMaxMessageSize(long maxMessageSize) Sets the maximum size for a message that can be received on a channel configured with this setting.
void	setOperationTimeoutInSeconds(long operationTimeoutInSeconds) Sets the 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.

Inherited Members

ServiceRemotingProvider.getProvider(Class<?> type)

Method Details

createServiceRemotingClientFactory

public ServiceRemotingClientFactory createServiceRemotingClientFactory(ServiceRemotingCallbackClient callbackClient)

Creates a service remoting client factory for connecting to the service over remoted service interfaces.

Parameters:

callbackClient - The client implementation where the callbacks should be dispatched.

Returns:

A FabricTransportServiceRemotingClientFactory as ServiceProxyFactory to generate service proxy to talk to a stateless or stateful service over remoted actor interface.

createServiceRemotingListener

public ServiceRemotingListener createServiceRemotingListener(ServiceContext serviceContext, Service serviceImplementation)

Creates a service remoting listener for remoting the service interface.

Parameters:

serviceContext - The context of the service for which the remoting listener is being constructed.

serviceImplementation - The service implementation object.

Returns:

A FabricTransportServiceRemotingProvider as ServiceRemotingListener for the specified service implementation.

getConnectTimeoutInMilliseconds

public long getConnectTimeoutInMilliseconds()

Gets the connect timeout in milliseconds. This settings specifies the maximum time allowed for the connection to be established.

Returns:

The connect timeout in Milliseconds.

getKeepAliveTimeoutInSeconds

public long getKeepAliveTimeoutInSeconds()

Gets the keepAliveTimeoutInSeconds that provides a way to configure Tcp keep-alive option.

Returns:

value in Seconds. 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.

getMaxMessageSize

public long getMaxMessageSize()

Gets the maximum size for a message that can be received on a channel configured with this setting.

Returns:

The maximum size of the message in bytes. Default Value for MaxMessageSize used is 4194304 bytes

getOperationTimeoutInSeconds

public long getOperationTimeoutInSeconds()

Gets the 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.

Returns:

value in seconds.

setConnectTimeoutInMilliseconds

public void setConnectTimeoutInMilliseconds(long connectTimeoutInMilliseconds)

Sets the connect timeout in milliseconds. This settings specifies the maximum time allowed for the connection to be established.

Parameters:

connectTimeoutInMilliseconds - The connect timeout in Milliseconds.

setKeepAliveTimeoutInSeconds

public void setKeepAliveTimeoutInSeconds(long keepAliveTimeoutInSeconds)

Sets the keepAliveTimeoutInSeconds that 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.

Parameters:

keepAliveTimeoutInSeconds - keep alive timeout in seconds.

setMaxMessageSize

public void setMaxMessageSize(long maxMessageSize)

Sets the maximum size for a message that can be received on a channel configured with this setting.

Parameters:

maxMessageSize - The maximum size of the message in bytes.

setOperationTimeoutInSeconds

public void setOperationTimeoutInSeconds(long operationTimeoutInSeconds)

Sets the 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.

Parameters:

operationTimeoutInSeconds - value in Seconds.