teamspeak3

README

go-teanspeak3

Documentation

Index

• Constants
• func ReplaceAnsiEscapeCode(text string) string
• type Client
  • func NewClient(t Type, host string, port int, username string, password string) (client *Client, err error)
• type Protocol
  • func NewProtocol(t Type) (p Protocol, err error)
• type Query
  • func NewQuery(t Type) (q Query, err error)
• type Type

Constants

const (
	DefaultConnectTimeout = time.Second * 10
	DefaultMsgPipeLength  = 10
	MaxBufferSize         = 10 << 20
	DefaultBufferSize     = 4096
)

const (
	MinKeepAliveDuration = time.Second * 5
)

Functions

func ReplaceAnsiEscapeCode

func ReplaceAnsiEscapeCode(text string) string

Types

type Client

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

func NewClient

func NewClient(t Type, host string, port int, username string, password string) (client *Client, err error)

type Protocol

type Protocol interface {
	Connect(host string, port int, username string, password string) error
	Disconnect() error
	SetInput(content string) error
	GetOutputPipe() (<-chan string, error)
}

Protocol provide an interface to implement transport protocol

func NewProtocol

func NewProtocol(t Type) (p Protocol, err error)

type Query

type Query interface {
	Init(protocol Protocol, keepAliveDuration time.Duration, keepAliveData string, keepAliveResponseLines int) error
	Request(content string) error
	GetResponsePipe() (<-chan string, error)
	Close() error
}

Query provide an interface to implement standard io with protocol io

func NewQuery

func NewQuery(t Type) (q Query, err error)

type Type

type Type int

const (
	Ssh Type = iota
)