Documentation

SwarmInfo

Table of Contents

$cluster  : ClusterInfo|null
ClusterInfo represents information about the swarm as is returned by the.
$controlAvailable  : bool|null
$error  : string|null
$localNodeState  : string|null
Current local status of this node.
$managers  : int|null
Total number of managers in the swarm.
$nodeAddr  : string|null
IP address at which this node can be reached by other nodes in the.
$nodeID  : string|null
Unique identifier of for this node in the swarm.
$nodes  : int|null
Total number of nodes in the swarm.
$remoteManagers  : array<string|int, PeerNode>|null
List of ID's and addresses of other managers in the swarm.
getCluster()  : ClusterInfo|null
ClusterInfo represents information about the swarm as is returned by the.
getControlAvailable()  : bool|null
getError()  : string|null
getLocalNodeState()  : string|null
Current local status of this node.
getManagers()  : int|null
Total number of managers in the swarm.
getNodeAddr()  : string|null
IP address at which this node can be reached by other nodes in the.
getNodeID()  : string|null
Unique identifier of for this node in the swarm.
getNodes()  : int|null
Total number of nodes in the swarm.
getRemoteManagers()  : array<string|int, PeerNode>|null
List of ID's and addresses of other managers in the swarm.
setCluster()  : self
ClusterInfo represents information about the swarm as is returned by the.
setControlAvailable()  : self
setError()  : self
setLocalNodeState()  : self
Current local status of this node.
setManagers()  : self
Total number of managers in the swarm.
setNodeAddr()  : self
IP address at which this node can be reached by other nodes in the.
setNodeID()  : self
Unique identifier of for this node in the swarm.
setNodes()  : self
Total number of nodes in the swarm.
setRemoteManagers()  : self
List of ID's and addresses of other managers in the swarm.

Properties

$cluster

ClusterInfo represents information about the swarm as is returned by the.

protected ClusterInfo|null $cluster

$controlAvailable

protected bool|null $controlAvailable = false

$localNodeState

Current local status of this node.

protected string|null $localNodeState = ''

$managers

Total number of managers in the swarm.

protected int|null $managers

$nodeAddr

IP address at which this node can be reached by other nodes in the.

protected string|null $nodeAddr = ''

$nodeID

Unique identifier of for this node in the swarm.

protected string|null $nodeID = ''

$nodes

Total number of nodes in the swarm.

protected int|null $nodes

$remoteManagers

List of ID's and addresses of other managers in the swarm.

protected array<string|int, PeerNode>|null $remoteManagers

Methods

getCluster()

ClusterInfo represents information about the swarm as is returned by the.

public getCluster() : ClusterInfo|null

"/info" endpoint. Join-tokens are not included.

Return values
ClusterInfo|null

getControlAvailable()

public getControlAvailable() : bool|null
Return values
bool|null

getError()

public getError() : string|null
Return values
string|null

getLocalNodeState()

Current local status of this node.

public getLocalNodeState() : string|null
Return values
string|null

getManagers()

Total number of managers in the swarm.

public getManagers() : int|null
Return values
int|null

getNodeAddr()

IP address at which this node can be reached by other nodes in the.

public getNodeAddr() : string|null

swarm.

Return values
string|null

getNodeID()

Unique identifier of for this node in the swarm.

public getNodeID() : string|null
Return values
string|null

getNodes()

Total number of nodes in the swarm.

public getNodes() : int|null
Return values
int|null

getRemoteManagers()

List of ID's and addresses of other managers in the swarm.

public getRemoteManagers() : array<string|int, PeerNode>|null
Return values
array<string|int, PeerNode>|null

setCluster()

ClusterInfo represents information about the swarm as is returned by the.

public setCluster(ClusterInfo|null $cluster) : self

"/info" endpoint. Join-tokens are not included.

Parameters
$cluster : ClusterInfo|null
Return values
self

setControlAvailable()

public setControlAvailable(bool|null $controlAvailable) : self
Parameters
$controlAvailable : bool|null
Return values
self

setError()

public setError(string|null $error) : self
Parameters
$error : string|null
Return values
self

setLocalNodeState()

Current local status of this node.

public setLocalNodeState(string|null $localNodeState) : self
Parameters
$localNodeState : string|null
Return values
self

setManagers()

Total number of managers in the swarm.

public setManagers(int|null $managers) : self
Parameters
$managers : int|null
Return values
self

setNodeAddr()

IP address at which this node can be reached by other nodes in the.

public setNodeAddr(string|null $nodeAddr) : self

swarm.

Parameters
$nodeAddr : string|null
Return values
self

setNodeID()

Unique identifier of for this node in the swarm.

public setNodeID(string|null $nodeID) : self
Parameters
$nodeID : string|null
Return values
self

setNodes()

Total number of nodes in the swarm.

public setNodes(int|null $nodes) : self
Parameters
$nodes : int|null
Return values
self

setRemoteManagers()

List of ID's and addresses of other managers in the swarm.

public setRemoteManagers(array<string|int, PeerNode>|null $remoteManagers) : self
Parameters
$remoteManagers : array<string|int, PeerNode>|null
Return values
self

Search results