cim

README

cim

Cim golang package is a generic tcp client/server that can provide arbitrary CLI services

To install do

1. $ go get -u github.com/LDCS/cim
2. Create a cfg file in the format specified in example_ports.cfg based on yout needs.
3. Edit the following line in cim.go with the path to ports cfg file.

var cfgFile = "/path/to/ports.cfg"

Documentation

Overview

cim is a command line interface manager package Using this package one can create a cim server as well as a client

Index

• type CBfunc
• type CimConnection
  • func NewCimConnection(host, simInst, connId string) (*CimConnection, error)
  • func (cc *CimConnection) Close() error
  • func (cc *CimConnection) RunCommand(cmd string) (string, error)
• type CimNode
• type CimServer
  • func NewCimServer(host, simInst string, root *CimNode, data interface{}) (*CimServer, error)
  • func (cs *CimServer) Start() error
• type ExecData

Types

type CBfunc

type CBfunc func(interface{}, string, ...string) string

Callback accepts the shared data command, and arguments, returns a string

type CimConnection

type CimConnection struct {
	// contains filtered or unexported fields
}

func NewCimConnection

func NewCimConnection(host, simInst, connId string) (*CimConnection, error)

func (*CimConnection) Close

func (cc *CimConnection) Close() error

func (*CimConnection) RunCommand

func (cc *CimConnection) RunCommand(cmd string) (string, error)

type CimNode

type CimNode struct {
	IsLeaf    bool
	Name      string
	Path      string
	Children  []*CimNode
	Callbacks map[string]CBfunc
	Parent    *CimNode
}

type CimServer

type CimServer struct {
	// contains filtered or unexported fields
}

func NewCimServer

func NewCimServer(host, simInst string, root *CimNode, data interface{}) (*CimServer, error)

func (*CimServer) Start

func (cs *CimServer) Start() error

type ExecData

type ExecData struct {
	Callback CBfunc
	Cmd      string
	Args     []string
	Data     interface{}
	RetChan  chan string
}