package
0.2.0
Repository: https://github.com/vanadium/core.git
Documentation: pkg.go.dev

# Functions

CreateAndRegister creates a new set of flag groups as specified by the supplied flag group parameters and registers them with the supplied flag.FlagSet.
CreateAndRegisterListenFlags creates and registers the ListenFlags group with the supplied flag.FlagSet.
CreateAndRegisterPermissionsFlags creates and registers a PermissionsFlags with the supplied FlagSet.
CreateAndRegisterRuntimeFlags creates and registers a RuntimeFlags with the supplied flag.FlagSet.
CreateAndRegisterVirtualizedFlags creates and registers the VirtualizedFlags group with the supplied flag.FlagSet.
DefaultCredentialsDir returns the current default for --v23.credentials taking V23_CREDENTIALS into account.
DefaultCredentialsDirNoEnv returns the current default for --v23.credentials ignoring V23_CREDENTIALS.
DefaultHostPort returns the current default host port.
DefaultNamespaceRoots returns the current default value of -v23.namespace.root taking the environment variables V23_NAMESPACE_ROOT0..
DefaultNamespaceRootsNoEnv returns the current default value of -v23.namespace.root ignoring V23_NAMESPACE_ROOT0...
DefaultPermissions returns the current default values for --v23.permissions.file as a map.
DefaultPermissionsLiteral returns the current default value for --v23.permissions.literal.
DefaultProtocol returns the current default protocol.
DefaultProxy returns the current default proxy.
DefaultProxyLimit returns the current default proxy limit.
DefaultProxyPolicy returns the current default proxy policy.
DefaultVirtualizedFlagValues returns the default values to use for the Virtualized flags group taking V23_VIRTUALIZATION_PROVIDER into account.
No description provided by the author
NewListenFlags creates a new ListenFlags with appropriate defaults.
NewPermissionsFlags creates a PermissionsFlags with appropriate defaults.
NewRuntimeFlags creates a new RuntimeFlags with appropriate defaults.
NewVirtualizedFlags creates a new VirtualizedFlags with appropriate defaults.
RegisterListenFlags registers the supplied ListenFlags variable with the supplied FlagSet.
RegisterPermissionsFlags registers the supplied PermissionsFlags with the supplied FlagSet.
RegisterRuntimeFlags registers the supplied RuntimeFlags variable with the supplied FlagSet.
RegisterVirtualizedFlags registers the supplied VirtualizedFlags variable with the supplied FlagSet.
SetDefaultCredentialsDir sets the default value for --v23.credentials.
SetDefaultHostPort sets the default host and port used when --v23.tcp.address is not provided.
SetDefaultNamespaceRoots sets the default value for --v23.namespace.root.
SetDefaultPermissions adds a name, file pair to the default value for --v23.permissions.file.
SetDefaultPermissionsLiteral sets the default value for --v23.permissions.literal.
SetDefaultProtocol sets the default protocol used when --v23.tcp.protocol is not provided.
SetDefaultProxy sets the default proxy used when --v23.proxy is not provided.
SetDefaultProxyLimit sets the default proxy used when --v23.proxy.limit is not provided.
SetDefaultProxyPolicy sets the default proxy used when --v23.proxy.policy is not provided.
SetDefaultVirtualizedFlagValues sets the default values to use for the Virtualized flags group.
No description provided by the author

# Constants

AWS is reserved for Amazon Web Services.
GCP is reserved for Google's Compute Platform.
Listen identifies the flags typically required to configure rpc.ListenSpec.
Native is reserved for any/all non-virtualized environments.
Permissions identifies the flags typically required to configure authorization.
Runtime identifies the flags and associated environment variables used by the Vanadium process runtime.
Virtualized identifies the flags typically required to configure a server running in some form of virtualized or isolated environment such as AWS, GCE or within a docker container.

# Structs

Flags represents the set of flag groups created by a call to CreateAndRegister.
HostPortFlag implements flag.Value to provide validation of the command line value it is set to.
IPFlag implements flag.Value in order to provide validation of IP addresses in the flag package.
IPHostPortFlag implements flag.Value to provide validation of the command line value it is set to.
ListenFlags contains the values of the Listen flag group.
NamespaceRootFlag represents a flag.Value for --v23.namespace.root.
PermissionsFlag represents a flag.Value for --v23.permissions.file.
PermissionsFlags contains the values of the PermissionsFlags flag group.
PermissionsLiteralFlag represents a flag.Value for --v23.permissions.literal.
RuntimeFlags contains the values of the Runtime flag group.
TCPProtocolFlag implements flag.Value to provide validation of the command line values passed to it: tcp, tcp4, tcp6, ws, ws4, ws6, wsh, wsh4, and wsh6 being the only allowed values.
VirtualizationProviderFlag represents.
VirtualizedFlagDefaults is used to set defaults for the Virtualized flag group.
VirtualizedFlags contains the values of the Virtualized flag group.
VtraceFlags represents the flags used to configure rpc tracing.

# Type aliases

FlagGroup is the type for identifying groups of related flags.
ListenAddrs is the set of listen addresses captured from the command line.
No description provided by the author
VirtualizationProvider identifies a particular virtualization provider/cloud computing vendor.