bgpmon

type BgpmondServer interface {
	// OpenSession opens a session of type sType, which must come from the config file.
	// The ID of this session is sID, which is used to interact with this
	// session, and wc is the worker count, or 0, to use a default wc of 1.
	OpenSession(sType, sID string, wc int) error

	// ListSessionTypes returns types which can be opened on the server. These are
	// defined in netsec-protobus, but the name of a SessionType returned
	// here should be a valid sType for OpenSession.
	ListSessionTypes() []*pb.SessionType

	// ListSessions returns a slice of currently active sesions on the server.
	// Each session handle includes a name, a session type, and a pointer to the
	// underlying session.
	ListSessions() []SessionHandle

	// CloseSession attempts to close active session with the provided session ID.
	// If that ID does not exist, or that session fails to close, this will return
	// an error.
	CloseSession(string) error

	// OpenWriteStream tries to open a write stream on the provided session ID with
	// the provided type. If the session doesn't exist or the WriteStream fails to
	// open, this will return an error.
	OpenWriteStream(string, db.SessionType) (db.WriteStream, error)

	// OpenReadStream tries to open a read stream on the provided session ID with
	// the provided type and filter options. If the session doesn't exist or the ReadStream
	// fails to open, this will return an error.
	OpenReadStream(string, db.SessionType, db.FilterOptions) (db.ReadStream, error)

	// RunModule will launch the module specified with mType with the ID mID. opts will
	// be passed to the modules Run function.
	RunModule(mType string, mID string, opts map[string]string) error

	// ListModuleTypes will return a slice of ModuleInfo specifying the type of module
	// and the options it accepts.
	ListModuleTypes() []ModuleInfo

	// ListRunningModules returns a slice of the active modules on the server.
	// OpenModuleInfo describes the modules type, options, and status.
	ListRunningModules() []OpenModuleInfo

	// CloseModule attempts to close an active module with the provided ID. If that ID
	// does not exist, or the module fails to close, this will return an error.
	CloseModule(string) error

	// Close will close all active modules, then all active sessions.
	Close() error
}

type Module interface {
	// Run starts the module, and is guaranteed to launch in a separate
	// goroutine. Args can be used to pass any information the module
	// needs.
	Run(args map[string]string)

	// GetType should return one of the module types defined above.
	GetType() int

	// GetName returns a string to identify the module type. Each
	// instance of a module should share the same name.
	GetName() string

	// GetInfo returns a struct containing info that describes the
	// running module.
	GetInfo() OpenModuleInfo

	// Stop is called to prematurely cancel a running module. The
	// module should be deallocated just after calling this. Stop
	// should be blocking until it knows the module has been stopped.
	Stop() error
}

type ModuleHandler struct {
	Info  ModuleInfo
	Maker ModuleMaker
}

type ModuleInfo struct {
	Type        string
	Description string
	Opts        string
}

type ModuleMaker func(BgpmondServer, util.Logger) Module

type OpenModuleInfo struct {
	Type   string
	ID     string
	Status string
}

type SessionHandle struct {
	Name     string
	SessType *pb.SessionType
	Session  *db.Session
}