com.vmware.sqlfire
Interface FabricService

All Known Subinterfaces:

FabricLocator, FabricServer

public interface FabricService

Base interface defining common peer services provided by FabricServer and FabricLocator.

Nested Class Summary

static class

FabricService.State Status of the service enumerating different states the service can be in.

Field Summary

static int	NETSERVER_DEFAULT_PORT the default port for network server
static String	STOP_NETWORK_SERVERS Shutdown boolean property to enable/disable shutting down of all network servers in stop(Properties).

Method Summary

Collection<NetworkInterface>	getAllNetworkServers() Get a collection of all the NetworkInterfaces started so far using startNetworkServer(String, int, Properties).
NetworkInterface	startNetworkServer(String bindAddress, int port, Properties networkProperties) Start listening for network clients on a given host/port address.
FabricService.State	status() Returns the status of this instance.
void	stop(Properties shutdownCredentials) Disconnect current virtual machine from distributed system.
void	stopAllNetworkServers() Stop all the NetworkInterfaces started using startNetworkServer(String, int, Properties).

Field Detail

NETSERVER_DEFAULT_PORT

static final int NETSERVER_DEFAULT_PORT

the default port for network server

See Also:

Constant Field Values

STOP_NETWORK_SERVERS

static final String STOP_NETWORK_SERVERS

Shutdown boolean property to enable/disable shutting down of all network servers in stop(Properties). Default is true.

See Also:

Constant Field Values

Method Detail

startNetworkServer

NetworkInterface startNetworkServer(String bindAddress,
                                    int port,
                                    Properties networkProperties)
                                    throws SQLException

Start listening for network clients on a given host/port address. This can be called multiple times to bind to multiple network interfaces.

Parameters:

bindAddress - The host name or IP address to bind the network server. If this is null then use the "bind-address" GemFire property and if found listens only on that address, else binds to local loopback address.

port - The port to bind the network server. A value <= 0 will cause this to use the default port NETSERVER_DEFAULT_PORT.

networkProperties - network server properties.

Throws:

SQLException

stopAllNetworkServers

void stopAllNetworkServers()
                           throws SQLException

Stop all the NetworkInterfaces started using startNetworkServer(String, int, Properties).

Throws:

SQLException

getAllNetworkServers

Collection<NetworkInterface> getAllNetworkServers()

Get a collection of all the NetworkInterfaces started so far using startNetworkServer(String, int, Properties).

stop

void stop(Properties shutdownCredentials)
          throws SQLException

Disconnect current virtual machine from distributed system. This should be called once for every startup of the service.

Parameters:

shutdownCredentials - Can optionally be null if Authentication is switched off, otherwise system user authentication credentials with which this instance was started.

Throws:

SQLException

status

FabricService.State status()

Returns the status of this instance.

Returns:

FabricService.State