package
0.0.0-20210606134709-2df04ca26d36
Repository: https://github.com/riccardomanfrin/netconfd.git
Documentation: pkg.go.dev

# Functions

DeleteErrorResponse maps Delete requests errors into HTTP status codes.
EncodeJSONResponse uses the json encoder to write an interface to the http response with an optional status code.
GetErrorResponse maps Get requests errors into HTTP status codes.
Logger wrapper for logging before inner HTTP serving.
NewAttributeDoesntBelongToLinkKindSemanticError returns an error for an attribute not belonging to the discriminated object.
NewConfig instantiates a new Config object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewConfigWithDefaults instantiates a new Config object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDhcp instantiates a new Dhcp object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDhcpWithDefaults instantiates a new Dhcp object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDns instantiates a new Dns object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDnsWithDefaults instantiates a new Dns object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGlobal instantiates a new Global object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGlobalMgmt instantiates a new GlobalMgmt object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGlobalMgmtWithDefaults instantiates a new GlobalMgmt object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGlobalWithDefaults instantiates a new Global object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewLink instantiates a new Link object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewLinkAddrInfo instantiates a new LinkAddrInfo object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewLinkAddrInfoWithDefaults instantiates a new LinkAddrInfo object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewLinkLinkinfo instantiates a new LinkLinkinfo object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewLinkLinkinfoInfoData instantiates a new LinkLinkinfoInfoData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewLinkLinkinfoInfoDataWithDefaults instantiates a new LinkLinkinfoInfoData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewLinkLinkinfoInfoSlaveData instantiates a new LinkLinkinfoInfoSlaveData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewLinkLinkinfoInfoSlaveDataWithDefaults instantiates a new LinkLinkinfoInfoSlaveData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewLinkLinkinfoWithDefaults instantiates a new LinkLinkinfo object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewLinkWithDefaults instantiates a new Link object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewMissingRequiredAttributeForLinkKindSemanticError returns an error for a missing attribute.
NewNetns instantiates a new Netns object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNetnsWithDefaults instantiates a new Netns object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNetwork instantiates a new Network object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNetworkApiController creates a default api controller.
NewNetworkApiService creates a default api service.
NewNetworkWithDefaults instantiates a new Network object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewRoute instantiates a new Route object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRouter creates a new router for any number of api routers.
NewRouteWithDefaults instantiates a new Route object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRule instantiates a new Rule object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRuleWithDefaults instantiates a new Rule object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSystemApiController creates a default api controller.
NewSystemApiService creates a default api service.
NewUnmanaged instantiates a new Unmanaged object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUnmanagedWithDefaults instantiates a new Unmanaged object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PatchErrorResponse maps Put requests errors into HTTP status codes.
PostErrorResponse maps Post requests errors into HTTP status codes.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.
PutErrorResponse maps Put requests errors into HTTP status codes.
ReadFormFileToTempFile reads file data from a request form and writes it to a temporary file.
Response return a ImplResponse struct filled.

# Constants

List of link_flag.
List of scope.
List of scope.
List of link_flag.
List of link_flag.
List of scope.
List of link_flag.
List of dnsid.
List of dnsid.
List of scope.
List of scope.
List of link_flag.

# Variables

No description provided by the author

# Structs

Config struct for Config.
Dhcp DHCP link context to enable.
No description provided by the author
No description provided by the author
Dns Name server for DNS resolution.
Global Application generic global config.
GlobalMgmt Management address.
A HTTPRoute defines the parameters for an api endpoint.
Implementation response defines an error code with the associated body.
Link Definition of an ip link interface (emulating iproute2 API) References: * [Linux Networking](https://www.kernel.org/doc/Documentation/networking/) * [Linux Bonding](https://www.kernel.org/doc/Documentation/networking/bonding.txt) * [Links Operstate](https://www.kernel.org/doc/Documentation/networking/operstates.txt).
LinkAddrInfo struct for LinkAddrInfo.
LinkLinkinfo Additional link info attributes.
LinkLinkinfoInfoData Additional information on the link.
LinkLinkinfoInfoSlaveData Info about slave state/config.
Netns Network Namespace.
Network struct for Network.
A NetworkApiController binds http requests to an api service and writes the service results to the http response.
NetworkApiService is a service that implents the logic for the NetworkApiServicer This service should implement the business logic for every endpoint for the NetworkApi API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Route IP L3 Ruote entry.
Rule IP Rule.
A SystemApiController binds http requests to an api service and writes the service results to the http response.
SystemApiService is a service that implents the logic for the SystemApiServicer This service should implement the business logic for every endpoint for the SystemApi API.
Unmanaged Unmanaged Resource For link type resources, the related context (routes or DHCP) are also unmanaged.

# Interfaces

NetworkApiRouter defines the required methods for binding the api requests to a responses for the NetworkApi The NetworkApiRouter implementation should parse necessary information from the http request, pass the data to a NetworkApiServicer to perform the required actions, then write the service results to the http response.
NetworkApiServicer defines the api actions for the NetworkApi service This interface intended to stay up to date with the openapi yaml used to generate it, while the service implementation can ignored with the .openapi-generator-ignore file and updated with the logic required for the API.
Router defines the required methods for retrieving api routes.
SystemApiRouter defines the required methods for binding the api requests to a responses for the SystemApi The SystemApiRouter implementation should parse necessary information from the http request, pass the data to a SystemApiServicer to perform the required actions, then write the service results to the http response.
SystemApiServicer defines the api actions for the SystemApi service This interface intended to stay up to date with the openapi yaml used to generate it, while the service implementation can ignored with the .openapi-generator-ignore file and updated with the logic required for the API.

# Type aliases

Dnsid ID of the DNS servers, defining their priority .
LinkFlag Flags of the interface Supported types: * `broadcast` - Request support for broadcast * `multicast` - Request support for multicast * `loopback` - Specify interface as loopback type * `pointtopoint` - Request support for point-to-point * `up` - Request link UP state .
Routes are a collection of defined api endpoints.
Scope scope of the object.