Documentation ¶
Overview ¶
Package varys is an abstraction that allows you to add or remove puppets, and receive a snapshot of state via an RPC-based interface.
Why "varys"? Because it is the Master of Whisperers.
Index ¶
- func NewServer()
- type Client
- type ConnectParams
- type InterpolationParams
- type NickParams
- type QuitParams
- type SendRawParams
- type SetupParams
- type Varys
- func (v *Varys) Connect(params ConnectParams, _ *struct{}) error
- func (v *Varys) Connected(uid string, result *bool) error
- func (v *Varys) GetNick(uid string, result *string) error
- func (v *Varys) GetUIDToNicks(_ struct{}, result *map[string]string) error
- func (v *Varys) Nick(params NickParams, _ *struct{}) error
- func (v *Varys) QuitIfConnected(params QuitParams, _ *struct{}) error
- func (v *Varys) SendRaw(params SendRawParams, _ *struct{}) error
- func (v *Varys) Setup(params SetupParams, _ *struct{}) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Client ¶
type Client interface { Setup(params SetupParams) error GetUIDToNicks() (map[string]string, error) Connect(params ConnectParams) error // Does not yet support netClient QuitIfConnected(uid string, quitMsg string) error Nick(uid string, nick string) error // SendRaw supports a blank uid to send to all connections. SendRaw(uid string, params InterpolationParams, messages ...string) error // GetNick gets the current connection's nick GetNick(uid string) (string, error) // Connected returns the status of the current connection Connected(uid string) (bool, error) }
func NewNetClient ¶
func NewNetClient() Client
type ConnectParams ¶
type InterpolationParams ¶
type InterpolationParams struct {
Nick bool
}
type NickParams ¶
type QuitParams ¶
type SendRawParams ¶
type SendRawParams struct { UID string Messages []string Interpolation InterpolationParams }
type SetupParams ¶
type Varys ¶
type Varys struct {
// contains filtered or unexported fields
}
func (*Varys) Connect ¶
func (v *Varys) Connect(params ConnectParams, _ *struct{}) error
func (*Varys) GetUIDToNicks ¶
func (*Varys) Nick ¶
func (v *Varys) Nick(params NickParams, _ *struct{}) error
func (*Varys) QuitIfConnected ¶
func (v *Varys) QuitIfConnected(params QuitParams, _ *struct{}) error
func (*Varys) SendRaw ¶
func (v *Varys) SendRaw(params SendRawParams, _ *struct{}) error
func (*Varys) Setup ¶
func (v *Varys) Setup(params SetupParams, _ *struct{}) error
Click to show internal directories.
Click to hide internal directories.