network

Documentation

Overview

Package network implements a Transport that works over a socket.

Index

• type Config
• type Transport
  • func New(conf tomlconf.ConfigHolder, logger *log.Logger) (*Transport, error)
  • func (t *Transport) GetHumanStatus() string
  • func (t *Transport) GetStatus() util.TransportStatus
  • func (t *Transport) IsRunning() bool
  • func (t *Transport) Run(start chan struct{}) (retcode int, ret string, _ error)
  • func (t *Transport) Stderr() <-chan []byte
  • func (t *Transport) Stdout() <-chan []byte
  • func (t *Transport) StopOrKill() error
  • func (t *Transport) StopOrKillTimeout(duration time.Duration) error
  • func (t *Transport) StopOrKillWaitgroup(group *sync.WaitGroup)
  • func (t *Transport) Update(confHolder tomlconf.ConfigHolder) error
  • func (t *Transport) Write(p []byte) (n int, err error)
  • func (t *Transport) WriteString(s string) (n int, err error)

Types

type Config

type Config struct {
	util.BaseConfig
	Name       xml.Name `xml:"config"`
	Address    string   `xml:"address"`
	StartLocal bool     `xml:"start_local"`
	IsUnix     bool     `xml:"is_unix,attr"`
	TLS        bool     `xml:"tls,attr"`
}

Config is a config for a networkTransport

type Transport

type Transport struct {
	*Config
	// contains filtered or unexported fields
}

Transport is an implementation of the transport interface that is designed to be used over the network

func New

func New(conf tomlconf.ConfigHolder, logger *log.Logger) (*Transport, error)

New creates a new network Transport

func (*Transport) GetHumanStatus

func (t *Transport) GetHumanStatus() string

GetHumanStatus returns the status of the transport that is human readable

func (*Transport) GetStatus

func (t *Transport) GetStatus() util.TransportStatus

GetStatus returns the current state of the transport

func (*Transport) IsRunning

func (t *Transport) IsRunning() bool

IsRunning returns whether or not the underlying process is currently running. For more information use GetStatus.

func (*Transport) Run

func (t *Transport) Run(start chan struct{}) (retcode int, ret string, _ error)

Run runs the underlying process on the Transport. It returns the return code of the process (or -1 if start failed) a string representation of the exit, if applicable, and an error. error should be checked first as the string may not be filled for some errors.

func (*Transport) Stderr

func (t *Transport) Stderr() <-chan []byte

Stderr returns a channel that will have lines from stdout sent over it. multiple calls are not supported.

func (*Transport) Stdout

func (t *Transport) Stdout() <-chan []byte

Stdout returns a channel that will have lines from stdout sent over it. multiple calls are not supported.

func (*Transport) StopOrKill

func (t *Transport) StopOrKill() error

StopOrKill implements StopOrKiller

func (*Transport) StopOrKillTimeout

func (t *Transport) StopOrKillTimeout(duration time.Duration) error

StopOrKillTimeout implements StopOrKiller

func (*Transport) StopOrKillWaitgroup

func (t *Transport) StopOrKillWaitgroup(group *sync.WaitGroup)

StopOrKillWaitgroup implements StopOrKiller

func (*Transport) Update

func (t *Transport) Update(confHolder tomlconf.ConfigHolder) error

Update updates the Transport with a TransportConfig

func (*Transport) Write

func (t *Transport) Write(p []byte) (n int, err error)

func (*Transport) WriteString

func (t *Transport) WriteString(s string) (n int, err error)

WriteString implements Transport