ClientVmRecord (GemFire XD Java API Documentation)

java.lang.Object
- hydra.ClientVmRecord

All Implemented Interfaces:

java.io.Serializable
```
public class ClientVmRecord
extends java.lang.Object
implements java.io.Serializable
```
A ClientVmRecord represents a running VM under control of the hydra master controller. It holds the ClientRecord objects for the client threads in this VM, plus runtime VM management information, such as the PID.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`DEAD`
`protected static int`	`DISCONNECTED`
`protected static int`	`LIVE`
`protected static int`	`NO_PID` Indicates that the process has no valid PID.
`protected static int`	`PENDING`
`protected static int`	`POTENTIAL`

Constructor Summary

Constructors
Constructor and Description

ClientVmRecord(int vmid, int basetid, ClientDescription cd)

Constructors
Constructor and Description
`ClientVmRecord(int vmid, int basetid, ClientDescription cd)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`acting()` Returns true if any client in the vm is in the process of initiating a dynamic action.
`protected void`	`addClient(ClientRecord cr)`
`protected void`	`bumpJavaHome()`
`protected void`	`bumpVersion()`
`protected void`	`decDynamicActionCount()` Decrements the count of clients initiating a dynamic action.
`protected boolean`	`fullyRegistered()` Returns true if all clients in this vm have registered.
`protected int`	`getBaseThreadId()`
`ClientRecord`	`getClient(int tid)`
`ClientDescription`	`getClientDescription()`
`java.lang.String`	`getClientName()`
`protected java.util.Map<java.lang.Integer,ClientRecord>`	`getClients()`
`protected java.util.Collection`	`getCopyOfClientCollection()` Returns a copy of the client record values map for use by the mapper.
`protected java.lang.String`	`getHost()`
`protected ClientVmInfo`	`getInfo()` Returns a fully specified `ClientVmInfo` for this VM.
`protected java.lang.String`	`getJavaHome()`
`protected java.lang.String`	`getLogicalHost()`
`protected HostHelper.OSType`	`getOSType()`
`int`	`getPid()`
`ClientRecord`	`getRepresentativeClient()`
`protected int`	`getState()`
`java.lang.String`	`getStateAsString(int state)`
`java.lang.String`	`getStateString()`
`protected java.lang.String`	`getVersion()`
`java.lang.Integer`	`getVmid()`
`protected void`	`incDynamicActionCount()` Increments the count of clients initiating a dynamic action.
`protected boolean`	`isDead()` Returns true if the vm is dead.
`protected boolean`	`isDisconnected()` Returns true if the vm was previously disconnected in a dynamic action and is not otherwise dead.
`protected boolean`	`isDynamic()` Returns true if the vm is undergoing dynamic action.
`protected boolean`	`isLive()` Returns true if the vm is live.
`protected boolean`	`matches(ClientVmInfo info)` Answers whether this client VM satisfies the requirements provided by the `ClientVmInfo`.
`void`	`notifyDynamicActionComplete(int actionId, int lastKnownPid)` Notifies this client VM that the dynamic action is complete.
`protected void`	`registerClient()` Registers a client with this vm.
`protected void`	`registerDisconnect()`
`protected boolean`	`registeredDisconnect()`
`protected void`	`reserve()`
`protected boolean`	`reserved()`
`protected void`	`reset()` Resets the vm to its primordial state (except for version and java home).
`protected void`	`resetForDisconnect()` Resets the vm to the proper state after a dynamic disconnect.
`protected void`	`setPid(int pid)`
`protected void`	`setState(int state)`
`java.lang.String`	`toClientString()`
`java.lang.String`	`toInfoString()`
`java.lang.String`	`toStateString()`
`java.lang.String`	`toString()` Print (cached) non-runtime information about the vm.
`protected void`	`unreserve()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NO_PID
```
protected static int NO_PID
```
    Indicates that the process has no valid PID.
  - POTENTIAL
```
protected static final int POTENTIAL
```
    See Also:
    
    Constant Field Values
  - PENDING
```
protected static final int PENDING
```
    See Also:
    
    Constant Field Values
  - LIVE
```
protected static final int LIVE
```
    See Also:
    
    Constant Field Values
  - DEAD
```
protected static final int DEAD
```
    See Also:
    
    Constant Field Values
  - DISCONNECTED
```
protected static final int DISCONNECTED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ClientVmRecord
```
public ClientVmRecord(int vmid,
                      int basetid,
                      ClientDescription cd)
```
- Method Detail
  - getVmid
```
public java.lang.Integer getVmid()
```
  - getBaseThreadId
```
protected int getBaseThreadId()
```
  - getClients
```
protected java.util.Map<java.lang.Integer,ClientRecord> getClients()
```
  - getClient
```
public ClientRecord getClient(int tid)
```
  - getRepresentativeClient
```
public ClientRecord getRepresentativeClient()
```
  - addClient
```
protected void addClient(ClientRecord cr)
```
  - getCopyOfClientCollection
```
protected java.util.Collection getCopyOfClientCollection()
```
    Returns a copy of the client record values map for use by the mapper. This is necessary since the mapper is destructive to the collection.
  - getClientDescription
```
public ClientDescription getClientDescription()
```
  - getClientName
```
public java.lang.String getClientName()
```
  - getLogicalHost
```
protected java.lang.String getLogicalHost()
```
  - getHost
```
protected java.lang.String getHost()
```
  - getOSType
```
protected HostHelper.OSType getOSType()
```
  - getState
```
protected int getState()
```
  - setState
```
protected void setState(int state)
```
  - getStateString
```
public java.lang.String getStateString()
```
  - getStateAsString
```
public java.lang.String getStateAsString(int state)
```
  - getJavaHome
```
protected java.lang.String getJavaHome()
```
  - bumpJavaHome
```
protected void bumpJavaHome()
```
  - getVersion
```
protected java.lang.String getVersion()
```
  - bumpVersion
```
protected void bumpVersion()
```
  - getPid
```
public int getPid()
```
  - setPid
```
protected void setPid(int pid)
```
  - registerClient
```
protected void registerClient()
```
    Registers a client with this vm.
  - fullyRegistered
```
protected boolean fullyRegistered()
```
    Returns true if all clients in this vm have registered.
  - incDynamicActionCount
```
protected void incDynamicActionCount()
```
    Increments the count of clients initiating a dynamic action.
  - decDynamicActionCount
```
protected void decDynamicActionCount()
```
    Decrements the count of clients initiating a dynamic action.
  - acting
```
protected boolean acting()
```
    Returns true if any client in the vm is in the process of initiating a dynamic action. This method is used to prevent interrupting a client in between the two RMI calls needed to initiate a dynamic action. It makes an atomic action out of reserving a target and invoking (but not waiting for return of) the action call.
  - reserve
```
protected void reserve()
```
  - unreserve
```
protected void unreserve()
```
  - reserved
```
protected boolean reserved()
```
  - isDynamic
```
protected boolean isDynamic()
```
    Returns true if the vm is undergoing dynamic action. Used by the complex task scheduler to avoid scheduling inappropriately.
  - registerDisconnect
```
protected void registerDisconnect()
```
  - registeredDisconnect
```
protected boolean registeredDisconnect()
```
  - isDisconnected
```
protected boolean isDisconnected()
```
    Returns true if the vm was previously disconnected in a dynamic action and is not otherwise dead. Used by the stop/start machinery to avoid restarting a JVM inappropriately.
  - isLive
```
protected boolean isLive()
```
    Returns true if the vm is live. Used by the simple task scheduler to avoid scheduling inappropriately.
  - isDead
```
protected boolean isDead()
```
    Returns true if the vm is dead. Used by the RebootMgr to avoid returning permanently dead vms.
  - reset
```
protected void reset()
```
    Resets the vm to its primordial state (except for version and java home).
  - resetForDisconnect
```
protected void resetForDisconnect()
```
    Resets the vm to the proper state after a dynamic disconnect.
  - matches
```
protected boolean matches(ClientVmInfo info)
```
    Answers whether this client VM satisfies the requirements provided by the ClientVmInfo.
  - notifyDynamicActionComplete
```
public void notifyDynamicActionComplete(int actionId,
                                        int lastKnownPid)
```
    Notifies this client VM that the dynamic action is complete. Uses any handy client record to connect.
  - getInfo
```
protected ClientVmInfo getInfo()
```
    Returns a fully specified ClientVmInfo for this VM.
  - toString
```
public java.lang.String toString()
```
    Print (cached) non-runtime information about the vm.
    
    Overrides:
    
    toString in class java.lang.Object
  - toInfoString
```
public java.lang.String toInfoString()
```
  - toStateString
```
public java.lang.String toStateString()
```
  - toClientString
```
public java.lang.String toClientString()
```

Class ClientVmRecord

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_PID

POTENTIAL

PENDING

LIVE

DEAD

DISCONNECTED

Constructor Detail

ClientVmRecord

Method Detail

getVmid

getBaseThreadId

getClients

getClient

getRepresentativeClient

addClient

getCopyOfClientCollection

getClientDescription

getClientName

getLogicalHost

getHost

getOSType

getState

setState

getStateString

getStateAsString

getJavaHome

bumpJavaHome

getVersion

bumpVersion

getPid

setPid

registerClient

fullyRegistered

incDynamicActionCount

decDynamicActionCount

acting

reserve

unreserve

reserved

isDynamic

registerDisconnect

registeredDisconnect

isDisconnected

isLive

isDead

reset

resetForDisconnect

matches

notifyDynamicActionComplete

getInfo

toString

toInfoString

toStateString

toClientString