msgs

Documentation

Index

• func ConnIP(conn *tls.Conn) (ip net.IP, err error)
• func ConnId(conn *tls.Conn) (id string, err error)
• func Encode(enc *gob.Encoder, msg Message) (err error)
• func SetDefaultVersion(version ProtocolVersion)
• type Client
  • func NewClient(conn *tls.Conn) (client Client, err error)
• type Message
  • func DaemonRegister() Message
  • func Decode(dec *gob.Decoder) (msg Message, err error)
  • func Err() Message
  • func NewMessage(msgT MessageType) Message
  • func Ok() Message
  • func Ping() Message
  • func Pong() Message
  • func String(data string) Message
  • func (m *Message) Size() int
• type MessageType
  • func (mt MessageType) String() string
• type Messenger
  • func NewMessenger(conn *tls.Conn) Messenger
• type ProtocolVersion

Functions

func ConnIP

func ConnIP(conn *tls.Conn) (ip net.IP, err error)

func ConnId

func ConnId(conn *tls.Conn) (id string, err error)

func Encode

func Encode(enc *gob.Encoder, msg Message) (err error)

func SetDefaultVersion

func SetDefaultVersion(version ProtocolVersion)

Types

type Client

type Client struct {
	// Hmmmm not sure what fields are needed yet
	Id string
	IP net.IP
}

func NewClient

func NewClient(conn *tls.Conn) (client Client, err error)

type Message

type Message struct {
	Type             MessageType
	Version          ProtocolVersion
	UnixTimestampUtc int64
	Payload          []byte
}

func DaemonRegister

func DaemonRegister() Message

func Decode

func Decode(dec *gob.Decoder) (msg Message, err error)

func Err

func Err() Message

func NewMessage

func NewMessage(msgT MessageType) Message

func Ok

func Ok() Message

func Ping

func Ping() Message

func Pong

func Pong() Message

func String

func String(data string) Message

func (*Message) Size

func (m *Message) Size() int

type MessageType

type MessageType uint8

const (
	T_Ok MessageType = iota
	T_Err
	T_String

	T_Ping
	T_Pong

	T_DaemonRegister
	T_ClientGetIPs

	T_ClientGrantAuthorization
	T_ClientRevokeAuthorization
)

func (MessageType) String

func (mt MessageType) String() string

type Messenger

type Messenger interface {
	Send(msg Message) (err error)
	SendN(msg Message) (n int, err error)
	Receive() (msg Message, err error)

	SetDeadline(deadline time.Time) (err error)
	SetReadDeadline(deadline time.Time) (err error)
	SetWriteDeadline(deadline time.Time) (err error)

	SetTimeout(timeout time.Duration) (err error)
	SetReadTimeout(timeout time.Duration) (err error)
	SetWriteTimeout(timeout time.Duration) (err error)
}

func NewMessenger

func NewMessenger(conn *tls.Conn) Messenger

type ProtocolVersion

type ProtocolVersion uint8

const (
	Version_1_0_0 ProtocolVersion = iota
)

var DefaultVersion ProtocolVersion = Version_1_0_0