All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class JavaGroups.GroupRequest

java.lang.Object
   |
   +----JavaGroups.GroupRequest

public class GroupRequest

extends Object

implements RspCollector

When started an array of responses, correlating to the membership, is created. Each response is added to the corresponding field in the array. When all fields have been set, the algorithm terminates. This algorithm can optionally use a suspicion service (failure detector) to detect (and exclude from the membership) fauly members. If no suspicion service is available, timeouts can be used instead (see Execute). When done, a list of suspected members can be retrieved.

Because a channel might deliver requests, and responses to different requests, the GroupRequest class cannot itself receive and process requests/responses from the channel. A mechanism outside this class has to do this; it has to determine what the responses are for the message sent by the Execute method and call ReceiveResponse to do so.

Requirements: lossless delivery, e.g. acknowledgement-based message confirmation.

GET_ABS_MAJORITY

GET_ALL

GET_FIRST

GET_MAJORITY

GET_N

GET_NONE

GroupRequest(Message, RequestCorrelator, Vector, int)

GroupRequest(Message, RequestCorrelator, Vector, int, long, int)

Execute()

Sends the message.

GetNumSuspects()

GetResults()

Returns the results as a RspList.

GetSuspects()

IsDone()

ReceiveResponse(Message)

Callback (called by RequestCorrelator).

Reset(Message, int, long)

Resets the group request, so it can be reused for another execution.

Reset(Message, Vector, int, long, int)

Reset(Vector)

Suspect(Object)

Callback (called by RequestCorrelator).

toString()

ViewChange(View)

Any member of 'membership' that is not in the new view is flagged as SUSPECTED.

 public static final int GET_FIRST

 public static final int GET_ALL

 public static final int GET_MAJORITY

 public static final int GET_ABS_MAJORITY

 public static final int GET_N

 public static final int GET_NONE

 public GroupRequest(Message m,
                     RequestCorrelator corr,
                     Vector members,
                     int rsp_mode)

Parameters:

m - The message to be sent

corr - The request correlator to be used. A request correlator sends requests tagged with a unique ID and notifies the sender when matching responses are received. The reason GroupRequest uses it instead of a Transport is that multiple requests/responses might be sent/received concurrently.

members - The initial membership. This value reflects the membership to which the request is sent (and from which potential responses are expected). Is reset by Reset().

rsp_mode - How many responses are expected. Can be

1. GET_ALL: wait for all responses from non-suspected members. A suspicion service might warn us when a member from which a response is outstanding has crashed, so it can be excluded from the responses. If no suspision service is available, a timeout can be used (a value of 0 means wait forever). If a timeout of 0 is used, no suspicion service is available and a member from which we expect a response has crashed, this methods blocks forever !.
2. GET_FIRST: wait for the first available response.
3. GET_MAJORITY: wait for the majority of all responses. The majority is re-computed when a member is suspected.
4. GET_ABS_MAJORITY: wait for the majority of all members. This includes failed members, so it may block if no timeout is specified.
5. GET_N: wait for N members. Return if n is >= membership+suspects.
6. GET_NONE: don't wait for any response. Essentially send an asynchronous message to the group members.

expected_mbrs - Number of responses expected (used with GET_ALL).

 public GroupRequest(Message m,
                     RequestCorrelator corr,
                     Vector members,
                     int rsp_mode,
                     long timeout,
                     int expected_mbrs)

Parameters:

timeout - Time to wait for responses (ms). A value of <= 0 means wait indefinitely (e.g. if a suspicion service is available; timeouts are not needed).

 public synchronized boolean Execute()

Sends the message. Returns when n responses have been received, or when a timeout has occurred. n can be the first response, all responses, or a majority of the responses.

 public void Reset(Message m,
                   int mode,
                   long timeout)

Resets the group request, so it can be reused for another execution.

 public void Reset(Message m,
                   Vector members,
                   int rsp_mode,
                   long timeout,
                   int expected_rsps)

 public void Reset(Vector members)

 public void ReceiveResponse(Message m)

Callback (called by RequestCorrelator). Adds a response to the response table. When all responses have been received, Execute returns.

 public void Suspect(Object suspected_member)

Callback (called by RequestCorrelator). Report to GroupRequest that a member is reported as faulty (suspected). This method would probably be called when getting a suspect message from a failure detector (where available). It is used to exclude faulty members from the response list.

 public void ViewChange(View new_view)

Any member of 'membership' that is not in the new view is flagged as SUSPECTED.

 public RspList GetResults()

Returns the results as a RspList.

 public String toString()

Overrides:

toString in class Object

 public int GetNumSuspects()

 public Vector GetSuspects()

 public boolean IsDone()

All Packages  Class Hierarchy  This Package  Previous  Next  Index