PHP Class Airship\Engine\Continuum\Channel

Abstracts a lot of the Channel features away from other code

Protected Properties

Property	Type	Description
$ext	string
$name	string
$parent	Continuum \| Keyggdrasil
$peers	Peer[]
$publicKey	ParagonIE\Halite\Asymmetric\SignaturePublicKey
$urls	string[]

Method	Description
__construct ( object $parent, string $name, array $config = [] )	Channel constructor.
createSupplier ( array $data ) : Supplier	Create a new supplier.
getAllSuppliers ( ) : array	Get all suppliers for a particular channel
getAllURLs ( boolean $doNotShuffle = false ) : array	Get all URLs
getAppropriatePeerSize ( integer $sizeOfList ) : integer	The natural log of the size of the peer list, rounded up.
getName ( ) : string
getPeerList ( boolean $forceFlush = false ) : array	Get a list of peers for a given channel
getPublicKey ( ) : SignaturePublicKey
getSupplier ( string $name, boolean $flush = false ) : Supplier	Get a supplier
getURL ( ) : string	Get a random URL

Channel constructor.

public __construct ( object $parent, string $name, array $config = [] )
$parent	object	(Continuum or Keyggdrasil)
$name	string
$config	array

Create a new supplier.

public createSupplier ( array $data ) : Supplier
$data	array
return	Supplier

Get all suppliers for a particular channel

public getAllSuppliers ( ) : array
return	array

By default, this shuffles them randomly. If you're in tor-only mode, it prioritizes .onion domains first.

public getAllURLs ( boolean $doNotShuffle = false ) : array
$doNotShuffle	boolean
return	array

The natural log of the size of the peer list, rounded up.

public getAppropriatePeerSize ( integer $sizeOfList ) : integer
$sizeOfList	integer
return	integer

public getName ( ) : string
return	string

Get a list of peers for a given channel

public getPeerList ( boolean $forceFlush = false ) : array
$forceFlush	boolean
return	array

public getPublicKey ( ) : SignaturePublicKey
return	ParagonIE\Halite\Asymmetric\SignaturePublicKey

Get a supplier

public getSupplier ( string $name, boolean $flush = false ) : Supplier
$name	string
$flush	boolean
return	Supplier

Get a random URL

public getURL ( ) : string
return	string

protected string $ext
return	string

protected string $name
return	string

protected Continuum\|Keyggdrasil $parent
return	Continuum \| Keyggdrasil

protected Peer[] $peers
return	Peer[]

protected SignaturePublicKey,ParagonIE\Halite\Asymmetric $publicKey
return	ParagonIE\Halite\Asymmetric\SignaturePublicKey

protected string[] $urls
return	string[]