class BridgeConfig

August 13, 2019 ยท View on GitHub

Member values

Member nameData typeDescription
device_identifieruint32Identifier of the device to which the bridge is connecting.
bridgetypeuint32Bridge type.
port_configBridgePortConfigPort configuration. If used to enable port bridging, it is optional. If no port config is given defaults for bridge type is used.
bridge_idBridgeIdentifierBridge identifier. Not used when creating bridge. It is used when retrieving configuration.

Member functions

Function nameReturn typeInput typeDescription
device_identifier()uint32voidReturns the current value of device_identifier. If the device_identifier is not set, returns 0.
set_device_identifier()voiduint32Sets the value of device_identifier. After calling this, device_identifier() will return value.
clear_device_identifier()voidvoidClears the value of device_identifier. After calling this, device_identifier() will return 0.
bridgetype() constuint32voidReturns the current value of bridgetype. If the bridgetype is not set, returns 0.
set_bridgetype()voiduint32Sets the value of bridgetype. After calling this, bridgetype() will return value.
clear_bridgetype()voidvoidClears the value of bridgetype. After calling this, bridgetype() will return the empty string/empty bytes.
has_port_config() constboolvoidReturns true if port_config is set.
port_config()const BridgePortConfig&voidReturns the current value of port_config. If port_config is not set, returns a BridgePortConfig with none of its fields set (possibly port_config::default_instance()).
mutable_port_config()BridgePortConfig *voidReturns a pointer to the mutable BridgePortConfig object that stores the field's value. If the field was not set prior to the call, then the returned BridgePortConfig will have none of its fields set (i.e. it will be identical to a newly-allocated BridgePortConfig). After calling this, has_port_config() will return true and port_config() will return a reference to the same instance of BridgePortConfig.
clear_port_config()voidvoidClears the value of the field. After calling this, has_port_config() will return false and port_config() will return the default value.
set_allocated_port_config()voidBridgePortConfig *Sets the BridgePortConfig object to the field and frees the previous field value if it exists. If the BridgePortConfig pointer is not NULL, the message takes ownership of the allocated BridgePortConfig object and has_ BridgePortConfig() will return true. Otherwise, if the port_config is NULL, the behavior is the same as calling clear_port_config().
release_port_config()BridgePortConfig *voidReleases the ownership of the field and returns the pointer of the BridgePortConfig object. After calling this, caller takes the ownership of the allocated BridgePortConfig object, has_port_config() will return false, and port_config() will return the default value.
has_bridge_id() constboolvoidReturns true if bridge_id is set.
bridge_id()const BridgeIdentifier&voidReturns the current value of bridge_id. If bridge_id is not set, returns a BridgeIdentifier with none of its fields set (possibly bridge_id::default_instance()).
mutable_bridge_id()BridgeIdentifier *voidReturns a pointer to the mutable BridgeIdentifier object that stores the field's value. If the field was not set prior to the call, then the returned BridgeIdentifier will have none of its fields set (i.e. it will be identical to a newly-allocated BridgeIdentifier). After calling this, has_bridge_id() will return true and bridge_id() will return a reference to the same instance of BridgeIdentifier.
clear_bridge_id()voidvoidClears the value of the field. After calling this, has_bridge_id() will return false and bridge_id() will return the default value.
set_allocated_bridge_id()voidBridgeIdentifier *Sets the BridgeIdentifier object to the field and frees the previous field value if it exists. If the BridgeIdentifier pointer is not NULL, the message takes ownership of the allocated BridgeIdentifier object and has_ BridgeIdentifier() will return true. Otherwise, if the bridge_id is NULL, the behavior is the same as calling clear_bridge_id().
release_bridge_id()BridgeIdentifier *voidReleases the ownership of the field and returns the pointer of the BridgeIdentifier object. After calling this, caller takes the ownership of the allocated BridgeIdentifier object, has_bridge_id() will return false, and bridge_id() will return the default value.

Parent topic: Base (C++)