package
0.0.0-20210422171800-c4606bf04420
Repository: https://github.com/liqotech/liqo-agent.git
Documentation: pkg.go.dev
# Functions
DestroyMockedIndicator destroys the Indicator singleton fortesting purposes.
DestroyStatus is a testing function used to refresh the Status component.
GetGuiProvider returns the guiProvider singleton that provides the functions to interact with the graphic server.
GetIndicator initializes and returns the Indicator singleton.
GetStatus initializes and returns the Status singleton.
Run starts the Indicator execution, running the onReady() function.
UseMockedGuiProvider enables a mocked guiProvider that does not interact with the OS graphic server.The real guiProvider internally exploits github.com/getlantern/systray to orchestrate GUI execution.
# Constants
Icon displayed in the tray bar.
Icon displayed in the tray bar.
Icon displayed in the tray bar.
Icon displayed in the tray bar.
Icon displayed in the tray bar.
Icon displayed in the tray bar.
Icon displayed in the tray bar.
Icon displayed in the tray bar.
Icon displayed in the tray bar.
Icon displayed in the tray bar.
Icon displayed in the tray bar.
NodeTypeAction represents a NodeType of an ACTION MenuNode: launches an application command.It can open command submenu (if present).
NodeTypeList represents a NodeType of a LIST MenuNode: placeholder MenuNode used to dynamicallydisplay application output.
NodeTypeOption represents a NodeType of an OPTION MenuNode: submenu choice (hidden by default).
NodeTypeQuick represents a NodeType of a QUICK MenuNode: simple shortcut to perform quick actions,e.g.
NodeTypeRoot represents a NodeType of a ROOT MenuNode: root of the Menu Tree.
NodeTypeStatus represents a NodeType of a STATUS MenuNode: non clickable node that displays status informationabout Liqo.
NodeTypeTitle represents a NodeType of a TITLE MenuNode: node with special text formattingused to display the menu header.
NotifyEventPeeringOff defines the event of a peering that has been torn down.
NotifyEventPeeringOn defines the event of a peering that has been established.
Liqo icon set for the Indicator notification system.
Liqo icon set for the Indicator notification system.
Liqo icon set for the Indicator notification system.
Liqo icon set for the Indicator notification system.
Liqo icon set for the Indicator notification system.
NotifyLevelMax: Indicator notifies events using Indicator's icon and label and desktop banners.
Textual descriptions of the NotifyLevel values.
NotifyLevelMin: Indicator notifies events only using Indicator's icon and label.
Textual descriptions of the NotifyLevel values.
NotifyLevelOff: disable all notifications.
Textual descriptions of the NotifyLevel values.
PeeringIncoming defines a peering where the home cluster shares its own resources with a foreign cluster.
PeeringOutgoing defines a peering where the home cluster is consuming the resources of a foreign cluster.
StatModeAutonomous defines the AUTONOMOUS working mode.
StatModeAutonomousBodyDescription is the extended description for the AUTONOMOUS mode.
StatModeAutonomousHeaderDescription is the short description for the AUTONOMOUS mode.
StatModeTethered defines the TETHERED working mode.
StatModeTetheredBodyDescription is the extended description for the TETHERED mode.
StatModeTetheredHeaderDescription is the short description for the TETHERED mode.
StatModeUnknownDescription is a fallback description for undefined mode received from the graphic input.
StatRunOff defines the 'OFF' running status of Liqo.
StatRunOn defines the 'ON' running status of Liqo.
# Structs
EventTester is a WaitGroup-based data struct that enables testers to validate concurrent operations performed
by the callback associated to an Indicator Listener (which reacts to specific events) or a MenuNode (which reacts when
the correspondent graphic menu entry is clicked).
Indicator is a stateful data structure that controls the app indicator and its related menu.
Listener is an event listener that can react calling a specific callback.
MenuNode is a stateful wrapper type that provides a better management of the Item type and additional features, such as submenus.
PeerInfo contains some basic information on a peer.
Status defines a data structure containing information about the current status of the Liqo instance,e.g.
Timer is a data structure that allows to control a time triggered loop execution of a callback.
# Interfaces
GuiProviderInterface wraps the methods to interact with the OS graphic server and manage a tray icon with its menu.
Item is an interface representing the actual item that gets pushed (and displayed) in the stack of the tray menu.
StatusInterface wraps the methods to manage the Indicator status.
# Type aliases
Icon represents the icon displayed in the tray bar.
NodeIcon represents a string prefix helping to graphically distinguish different kinds of Menu entries (NodeType).
NodeType defines the kind of a MenuNode, each one with specific features.
NotifyIcon represents the Liqo set of icons displayed in the desktop banners.
NotifyLevel is the level of the indicator notification system:.
NotifyPeeringEvent defines a type of event regarding a peering with a foreign cluster.
PeeringType defines a type of peering with a foreign cluster.
StatMode defines the Working Modes for Liqo, i.e.
StatRun defines the running status of Liqo.