no.rmz.blobee.controllers

Class RpcClientControllerImpl

java.lang.Object

no.rmz.blobee.controllers.RpcClientControllerImpl

All Implemented Interfaces:

com.google.protobuf.RpcController, RpcClientController, BlobeeRpcController

public final class RpcClientControllerImpl
extends Object
implements RpcClientController

An RPC controller that is used on the client side of an invocation.

Constructor Summary

Constructors

Constructor and Description
RpcClientControllerImpl() Construct a new controller instance to be used on the client side.

Method Summary

Methods

Modifier and Type	Method and Description
void	bindToInvocation(RpcClientSideInvocation invocation) Bind the controller to a record keeping track of the client side of an RPC invocation.
String	errorText()
boolean	failed()
long	getIndex() The index of the invocation.
boolean	isActive() True if the controller is associated with an RPC invocation that is still ongoing.
boolean	isCanceled()
boolean	isMultiReturn() True iff the invocation is multi-return.
boolean	isNoReturn() True iff the invocation is a no-return invocation.
void	notifyOnCancel(com.google.protobuf.RpcCallback<Object> callback)
void	reset()
void	setActive(boolean active) Setting the value that is read by isActive.
void	setClientAndIndex(RpcClientImpl rpcClient, long rpcIndex) Associate the client with a client and an index.
void	setFailed(String reason)
void	setMultiReturn() Set this invocation to be multi-return, meaning that a procedure can return more than one value.
void	setNoReturn() Set this invocation to be no-return, meaning that it is assumed that the return-value callback will not be invoked.
void	startCancel()

Methods inherited from class java.lang.Object

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

Constructor Detail

RpcClientControllerImpl

public RpcClientControllerImpl()

Construct a new controller instance to be used on the client side.

Method Detail

reset

public void reset()

Specified by:

reset in interface com.google.protobuf.RpcController

bindToInvocation

public void bindToInvocation(RpcClientSideInvocation invocation)

Description copied from interface: RpcClientController

Bind the controller to a record keeping track of the client side of an RPC invocation.

Specified by:

bindToInvocation in interface RpcClientController

Parameters:

invocation - The invocation that we want the controller to be associated with.

isActive

public boolean isActive()

Description copied from interface: RpcClientController

True if the controller is associated with an RPC invocation that is still ongoing.

Specified by:

isActive in interface RpcClientController

Returns:

True if the invocation is still ongoing.

setActive

public void setActive(boolean active)

Description copied from interface: RpcClientController

Setting the value that is read by isActive.

Specified by:

setActive in interface RpcClientController

Parameters:

active - New value of active field.

failed

public boolean failed()

Specified by:

failed in interface com.google.protobuf.RpcController

errorText

public String errorText()

Specified by:

errorText in interface com.google.protobuf.RpcController

startCancel

public void startCancel()

Specified by:

startCancel in interface com.google.protobuf.RpcController

setFailed

public void setFailed(String reason)

Specified by:

setFailed in interface com.google.protobuf.RpcController

isCanceled

public boolean isCanceled()

Specified by:

isCanceled in interface com.google.protobuf.RpcController

notifyOnCancel

public void notifyOnCancel(com.google.protobuf.RpcCallback<Object> callback)

Specified by:

notifyOnCancel in interface com.google.protobuf.RpcController

setClientAndIndex

public void setClientAndIndex(RpcClientImpl rpcClient,
                     long rpcIndex)

Description copied from interface: RpcClientController

Associate the client with a client and an index.

Specified by:

setClientAndIndex in interface RpcClientController

Parameters:

rpcClient - The client associated witht this controller.

rpcIndex - The index associated with this controller.

getIndex

public long getIndex()

Description copied from interface: RpcClientController

The index of the invocation. This is always associated to a particular RpcClient.

Specified by:

getIndex in interface RpcClientController

Returns:

setMultiReturn

public void setMultiReturn()

Description copied from interface: BlobeeRpcController

Set this invocation to be multi-return, meaning that a procedure can return more than one value.

Specified by:

setMultiReturn in interface BlobeeRpcController

isMultiReturn

public boolean isMultiReturn()

Description copied from interface: BlobeeRpcController

True iff the invocation is multi-return.

Specified by:

isMultiReturn in interface BlobeeRpcController

Returns:

true if invocation is multi-return.

setNoReturn

public void setNoReturn()

Description copied from interface: BlobeeRpcController

Set this invocation to be no-return, meaning that it is assumed that the return-value callback will not be invoked. Indeed it will represent an error situation to attempt to use the return callback.

Specified by:

setNoReturn in interface BlobeeRpcController

isNoReturn

public boolean isNoReturn()

Description copied from interface: BlobeeRpcController

True iff the invocation is a no-return invocation.

Specified by:

isNoReturn in interface BlobeeRpcController

Returns:

true if invocation is no-return.