README
¶
Gopkgs
Gopkgs is a collection of Go language (golang.org) packages (a.k.a. libraries) which support other projects in this github organisation (e.g. Tegu), and that might be useful to other projects.
Currently, the packages include:
arista
Methods for interfacing with an Arista switch which is configured to use HTTP or HTTPs interface.
bleater
A level based logging package.
chkpt
Provides an easy mechanism for creating dual-tumbler checkpoint files.
clike
Some tools (atoi-ish) that behave in a Clib manner, such as not aborting if a non-digit is encountered (ato* family) and add some extensions for values with post-fixed units (e.g. 10GiB or 10G).
config
A configuration file parser which provides for a section based file and allows for inclusion of sub files.
connman
A TCP connection manager.
extcmd
An external command interface which bundles the results (stdout/stderr) into a manageable structure for the caller.
http_logger
Provides a basic logger to log HTTP requests in the format that will be familiar to anyone who has ever used Apache.
ipc
Interprocess communications support. Provides a simple request/response message block and some wrapper functions to easily send a message on a channel. Also provides a tickler function that can be started and will send messages to a channel at prescribed times.
jsontools
Tools which assist with the parsing and streaming JSON management.
ostack
An interface to OpenStack which provides authorisation, and general queries making use of OpenStack as a data source.
security
Support for generating self-signed certificates.
ssh_broker
A broker which manages persistent SSH sessions with one or more hosts allowing for the remote execution of commands without the session setup overhead needed if each call were executed via a 'system()' like approach.
token
Tokenising functions providing features like tokens with quotes and embedded separators, unique token generation, token counting, etc.
Go Package Doc
Running the Go package documentation tool on any of the packages in this source should generate the documentation needed to make use of these packages. As an example
`godoc github.com/att/gopkgs/token`
will generate the documentation on the token package.
Directories
¶
| Path | Synopsis |
|---|---|
|
The arista package contains several methods which allow an application to easily send requests to an Arista switch which is configured with its HTTPs API enabled.
|
The arista package contains several methods which allow an application to easily send requests to an Arista switch which is configured with its HTTPs API enabled. |
|
Bleater: Something that goes baaa in the night.
|
Bleater: Something that goes baaa in the night. |
|
The chkpt package implements a checkpoint file manager.
|
The chkpt package implements a checkpoint file manager. |
|
The clike package provides some functions that behave more like the traditional Clib functions than functions supported by the Go packages.
|
The clike package provides some functions that behave more like the traditional Clib functions than functions supported by the Go packages. |
|
Provides the means to open and parse a sectioned configuration file.
|
Provides the means to open and parse a sectioned configuration file. |
|
Connman implements a connection manager that listens for TCP connections, accepts them and then manages the sessions providing received buffers on a channel to the application.
|
Connman implements a connection manager that listens for TCP connections, accepts them and then manages the sessions providing received buffers on a channel to the application. |
|
The extcmd package provides a simple interface which allows an external command to be invoked with the resulting stdout/err placed into a json formatted structure for the caller.
|
The extcmd package provides a simple interface which allows an external command to be invoked with the resulting stdout/err placed into a json formatted structure for the caller. |
|
This package provides a basic logger to log HTTP requests in the format that will be familiar to anyone who has ever used Apache.
|
This package provides a basic logger to log HTTP requests in the format that will be familiar to anyone who has ever used Apache. |
|
The chmsg provides a data structure that helps to manage interprocess communications between Goroutines via channels.
|
The chmsg provides a data structure that helps to manage interprocess communications between Goroutines via channels. |
|
msgrtr
Provides a message routing interface.
|
Provides a message routing interface. |
|
The jsontools package provides several functions which parse a json 'blob' into either a one dimensional map, or into a tree structure which may be 'walked'.
|
The jsontools package provides several functions which parse a json 'blob' into either a one dimensional map, or into a tree structure which may be 'walked'. |
|
Interface to the openstack environment.
|
Interface to the openstack environment. |
|
Rabbit_hole creates a simple interface to a RabbitMQ exchange allowing setup via one function call to Mk_mqreader() for reading and Mk_mqwriter() for sending.
|
Rabbit_hole creates a simple interface to a RabbitMQ exchange allowing setup via one function call to Mk_mqreader() for reading and Mk_mqwriter() for sending. |
|
Provides an interface to the ssh package that allows a local script (shell or python) to be read and sent to a remote host for execution.
|
Provides an interface to the ssh package that allows a local script (shell or python) to be read and sent to a remote host for execution. |
|
The token package provides functions which tokenise, or provide for the manipulation of tokenised strings.
|
The token package provides functions which tokenise, or provide for the manipulation of tokenised strings. |