Class: ControlParameters

ControlParameters

new ControlParameters()

A ControlParameters which holds a Name and other fields for a ControlParameters which is used, for example, in the command interest to register a prefix with a forwarder. See http://redmine.named-data.net/projects/nfd/wiki/ControlCommand#ControlParameters
Source:

Methods

getCost() → {number}

Get the cost value.
Source:
Returns:
The cost value, or null if not specified.
Type
number

getExpirationPeriod() → {number}

Get the expiration period.
Source:
Returns:
The expiration period in milliseconds, or null if not specified.
Type
number

getFaceId() → {number}

Get the face ID.
Source:
Returns:
The face ID, or null if not specified.
Type
number

getForwardingFlags() → {ForwardingFlags}

Get the ForwardingFlags object.
Source:
Returns:
The ForwardingFlags object.
Type
ForwardingFlags

getLocalControlFeature() → {number}

Get the local control feature value.
Source:
Returns:
The local control feature value, or null if not specified.
Type
number

getName() → {Name}

Get the name.
Source:
Returns:
The name. If not specified, return null.
Type
Name

getOrigin() → {number}

Get the origin value.
Source:
Returns:
The origin value, or null if not specified.
Type
number

getStrategy() → {Name}

Get the strategy.
Source:
Returns:
The strategy or an empty Name
Type
Name

getUri() → {string}

Get the URI.
Source:
Returns:
The face URI, or an empty string if not specified.
Type
string

setCost(cost)

Set the cost value.
Parameters:
Name Type Description
cost number The new cost value, or null for not specified.
Source:

setExpirationPeriod(expirationPeriod)

Set the expiration period.
Parameters:
Name Type Description
expirationPeriod number The expiration period in milliseconds, or null for not specified.
Source:

setFaceId(faceId)

Set the Face ID.
Parameters:
Name Type Description
faceId number The new face ID, or null for not specified.
Source:

setForwardingFlags(forwardingFlags)

Set the ForwardingFlags object to a copy of forwardingFlags. You can use getForwardingFlags() and change the existing ForwardingFlags object.
Parameters:
Name Type Description
forwardingFlags ForwardingFlags The new cost value, or null for not specified.
Source:

setLocalControlFeature(localControlFeature)

Set the local control feature value.
Parameters:
Name Type Description
localControlFeature number The new local control feature value, or null for not specified.
Source:

setName(name)

Set the name.
Parameters:
Name Type Description
name Name The name. If not specified, set to null. If specified, this makes a copy of the name.
Source:

setOrigin(origin)

Set the origin value.
Parameters:
Name Type Description
origin number The new origin value, or null for not specified.
Source:

setStrategy(strategy)

Set the strategy to a copy of the given Name.
Parameters:
Name Type Description
strategy Name The Name to copy, or an empty Name if not specified.
Source:

setUri(uri)

Set the URI.
Parameters:
Name Type Description
uri string The new uri, or an empty string for not specified.
Source:

wireDecode(input, wireFormat)

Decode the input using a particular wire format and update this ControlParameters.
Parameters:
Name Type Description
input Blob | Buffer The buffer with the bytes to decode.
wireFormat WireFormat (optional) A WireFormat object used to decode this object. If omitted, use WireFormat.getDefaultWireFormat().
Source:

wireEncode(wireFormat) → {Blob}

Encode this ControlParameters for a particular wire format.
Parameters:
Name Type Description
wireFormat WireFormat (optional) A WireFormat object used to encode this object. If omitted, use WireFormat.getDefaultWireFormat().
Source:
Returns:
The encoded buffer in a Blob object.
Type
Blob