Skip to content

Latest commit

 

History

History
28 lines (22 loc) · 4.43 KB

FullIPv4Configuration.md

File metadata and controls

28 lines (22 loc) · 4.43 KB

class FullIPv4Configuration

Member values

Member name Data type Description
handle NetworkHandle Network handle
ipv4_configuration IPv4Configuration IPv4 configuration

Member functions

Function name Return type Input type Description
has_handle() const bool void Returns true if handle is set.
handle() const NetworkHandle& void Returns the current value of handle. If handle is not set, returns a NetworkHandle with none of its fields set (possibly handle::default_instance()).
mutable_handle() NetworkHandle * void Returns a pointer to the mutable NetworkHandle object that stores the field's value. If the field was not set prior to the call, then the returned NetworkHandle will have none of its fields set (i.e. it will be identical to a newly-allocated NetworkHandle). After calling this, has_handle() will return true and handle() will return a reference to the same instance of NetworkHandle.
clear_handle() void void Clears the value of the field. After calling this, has_handle() will return false and handle() will return the default value.
set_allocated_handle() void NetworkHandle * Sets the NetworkHandle object to the field and frees the previous field value if it exists. If the NetworkHandle pointer is not NULL, the message takes ownership of the allocated NetworkHandle object and has_ NetworkHandle() will return true. Otherwise, if the handle is NULL, the behavior is the same as calling clear_handle().
release_handle() NetworkHandle * void Releases the ownership of the field and returns the pointer of the NetworkHandle object. After calling this, caller takes the ownership of the allocated NetworkHandle object, has_handle() will return false, and handle() will return the default value.
has_ipv4_configuration() const bool void Returns true if ipv4_configuration is set.
ipv4_configuration() const IPv4Configuration& void Returns the current value of ipv4_configuration. If ipv4_configuration is not set, returns a IPv4Configuration with none of its fields set (possibly ipv4_configuration::default_instance()).
mutable_ipv4_configuration() IPv4Configuration * void Returns a pointer to the mutable IPv4Configuration object that stores the field's value. If the field was not set prior to the call, then the returned IPv4Configuration will have none of its fields set (i.e. it will be identical to a newly-allocated IPv4Configuration). After calling this, has_ipv4_configuration() will return true and ipv4_configuration() will return a reference to the same instance of IPv4Configuration.
clear_ipv4_configuration() void void Clears the value of the field. After calling this, has_ipv4_configuration() will return false and ipv4_configuration() will return the default value.
set_allocated_ipv4_configuration() void IPv4Configuration * Sets the IPv4Configuration object to the field and frees the previous field value if it exists. If the IPv4Configuration pointer is not NULL, the message takes ownership of the allocated IPv4Configuration object and has_ IPv4Configuration() will return true. Otherwise, if the ipv4_configuration is NULL, the behavior is the same as calling clear_ipv4_configuration().
release_ipv4_configuration() IPv4Configuration * void Releases the ownership of the field and returns the pointer of the IPv4Configuration object. After calling this, caller takes the ownership of the allocated IPv4Configuration object, has_ipv4_configuration() will return false, and ipv4_configuration() will return the default value.

Parent topic: Base (C++)