alluxio.master.service.rpc

Class RpcServerService

java.lang.Object

alluxio.master.service.rpc.RpcServerService

All Implemented Interfaces:

SimpleService

Direct Known Subclasses:

RpcServerStandbyGrpcService

public class RpcServerService
extends Object
implements SimpleService

Created by RpcServerService.Factory. Manages the behavior of the master's rpc service. It deploys a rpc server only after being promoted. It stops said rpc web server after being demoted or stopped. When a rpc server is not deployed, a rejecting server is deployed instead (after the service has been started).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RpcServerService.Factory Factory to create an RpcServerService.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOG
protected InetSocketAddress	mBindAddress
protected GrpcServer	mGrpcServer The grpc server and its executor service (mRpcExecutor) need to be managed independently (i.e.
protected MasterProcess	mMasterProcess
protected MasterRegistry	mMasterRegistry
protected RejectingServer	mRejectingGrpcServer
protected AlluxioExecutorService	mRpcExecutor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RpcServerService(InetSocketAddress bindAddress, MasterProcess masterProcess, MasterRegistry masterRegistry)

Method Summary

Modifier and Type	Method and Description
void	demote() Demotes the service back to NodeState.STANDBY state.
protected boolean	isGrpcServerServing()
boolean	isServing()
boolean	isServingLeader()
boolean	isServingStandby()
void	promote() Promotes the service to NodeState.PRIMARY state.
void	start() Starts the service.
protected void	startGrpcServer(java.util.function.Function<Master,Map<ServiceType,GrpcService>> serviceProvider)
protected void	startRejectingServer()
void	stop() Stops the service altogether and cleans up any state left.
protected void	stopGrpcServer()
protected void	stopRejectingServer()
protected void	stopRpcExecutor()
static void	waitFor(boolean freeOrBound, InetSocketAddress address) Creates a buffer between rejecting server and regular serving server of at most 1 second.
protected void	waitForBound()
protected void	waitForFree()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

protected static final org.slf4j.Logger LOG

mBindAddress

protected final InetSocketAddress mBindAddress

mMasterProcess

protected final MasterProcess mMasterProcess

mMasterRegistry

protected final MasterRegistry mMasterRegistry

mGrpcServer

@Nullable
protected GrpcServer mGrpcServer

The grpc server and its executor service (mRpcExecutor) need to be managed independently (i.e. stopping the grpc server will not automatically stop the rpc executor)

mRpcExecutor

@Nullable
protected AlluxioExecutorService mRpcExecutor

mRejectingGrpcServer

@Nullable
protected RejectingServer mRejectingGrpcServer

Constructor Detail

RpcServerService

protected RpcServerService(InetSocketAddress bindAddress,
                           MasterProcess masterProcess,
                           MasterRegistry masterRegistry)

Method Detail

isGrpcServerServing

protected final boolean isGrpcServerServing()

isServing

public boolean isServing()

Returns:

whether the grpc server is serving or not

isServingLeader

public boolean isServingLeader()

Returns:

whether the grpc server is serving in leader mode

isServingStandby

public boolean isServingStandby()

Returns:

whether the grpc server is serving in standby mode

start

public void start()

Description copied from interface: SimpleService

Starts the service. Leaves the service in NodeState.STANDBY state. Leaves the service in the same state as SimpleService.demote(). Can only be called once.

Specified by:

start in interface SimpleService

promote

public void promote()

Description copied from interface: SimpleService

Promotes the service to NodeState.PRIMARY state. Can only be called on a started service (i.e. SimpleService.start() must precede this method). Can only be called in NodeState.STANDBY state. Can be called multiple times (e.g. a service is promoted, then demoted, then promoted again).

Specified by:

promote in interface SimpleService

startGrpcServer

protected void startGrpcServer(java.util.function.Function<Master,Map<ServiceType,GrpcService>> serviceProvider)

demote

public void demote()

Description copied from interface: SimpleService

Demotes the service back to NodeState.STANDBY state. Can only be called on a started service (i.e. SimpleService.start() must precede this method). Can only be called in NodeState.PRIMARY state (i.e. SimpleService.promote() must precede this method). Can be called multiple times (e.g. a service is promoted, then demoted, then promoted again, and demoted again).

Specified by:

demote in interface SimpleService

stop

public void stop()

Description copied from interface: SimpleService

Stops the service altogether and cleans up any state left. If SimpleService.start() has not been called on this service this method should be a noop. Can only be called once.

Specified by:

stop in interface SimpleService

stopGrpcServer

protected void stopGrpcServer()

stopRpcExecutor

protected void stopRpcExecutor()

startRejectingServer

protected void startRejectingServer()

stopRejectingServer

protected void stopRejectingServer()

waitForFree

protected void waitForFree()

waitForBound

protected void waitForBound()

waitFor

public static void waitFor(boolean freeOrBound,
                           InetSocketAddress address)

Creates a buffer between rejecting server and regular serving server of at most 1 second.

Parameters:

freeOrBound - determines if it prematurely returns when the port if free (false) or bound (true)

address - the address to test