msgs

Documentation

Index

• Variables
• type Ack
• type Add
• type Allocate
• type AllocatedResp
• type Bind
• type Claim
• type ClaimedResp
• type Close
• type ClosedResp
• type Error
• type GenericServerMsg
• type List
• type Message
• type Nameplates
• type Open
• type Release
• type ReleasedResp
• type Welcome
• type WelcomeServerInfo

Variables

var MsgMap = map[string]interface{}{
	"welcome":    Welcome{},
	"bind":       Bind{},
	"allocate":   Allocate{},
	"ack":        Ack{},
	"allocated":  AllocatedResp{},
	"claim":      Claim{},
	"claimed":    ClaimedResp{},
	"open":       Open{},
	"add":        Add{},
	"message":    Message{},
	"list":       List{},
	"nameplates": Nameplates{},
	"release":    Release{},
	"released":   ReleasedResp{},
	"error":      Error{},
	"close":      Close{},
	"closed":     ClosedResp{},
}

Types

type Ack

type Ack struct {
	Type     string  `json:"type" rendezvous_value:"ack"`
	ID       string  `json:"id"`
	ServerTX float64 `json:"server_tx"`
}

Server sent ack message

type Add

type Add struct {
	Type  string `json:"type" rendezvous_value:"add"`
	ID    string `json:"id"`
	Phase string `json:"phase"`
	// Body is a hex string encoded json submessage
	Body string `json:"body"`
}

Client sent add message to add a message to a mailbox.

type Allocate

type Allocate struct {
	Type string `json:"type" rendezvous_value:"allocate"`
	ID   string `json:"id"`
}

Client sent aollocate message

type AllocatedResp

type AllocatedResp struct {
	Type      string  `json:"type" rendezvous_value:"allocated"`
	Nameplate string  `json:"nameplate"`
	ServerTX  float64 `json:"server_tx"`
}

Server sent allocated message

type Bind

type Bind struct {
	Type  string `json:"type" rendezvous_value:"bind"`
	ID    string `json:"id"`
	Side  string `json:"side"`
	AppID string `json:"appid"`
	// ClientVersion is by convention a two value array
	// of [client_id, version]
	ClientVersion []string `json:"client_version"`
}

Client sent bind message

type Claim

type Claim struct {
	Type      string `json:"type" rendezvous_value:"claim"`
	ID        string `json:"id"`
	Nameplate string `json:"nameplate"`
}

Client sent claim message

type ClaimedResp

type ClaimedResp struct {
	Type     string  `json:"type" rendezvous_value:"claimed"`
	Mailbox  string  `json:"mailbox"`
	ServerTX float64 `json:"server_tx"`
}

Server sent claimed message

type Close

type Close struct {
	Type    string `json:"type" rendezvous_value:"close"`
	ID      string `json:"id"`
	Mailbox string `json:"mailbox"`
	Mood    string `json:"mood"`
}

type ClosedResp

type ClosedResp struct {
	Type     string  `json:"type" rendezvous_value:"closed"`
	ServerTx float64 `json:"server_tx"`
}

type Error

type Error struct {
	Type     string      `json:"type" rendezvous_value:"error"`
	Error    string      `json:"error"`
	Orig     interface{} `json:"orig"`
	ServerTx float64     `json:"server_tx"`
}

Server sent error message

type GenericServerMsg

type GenericServerMsg struct {
	Type     string  `json:"type"`
	ServerTX float64 `json:"server_tx"`
	ID       string  `json:"id"`
	Error    string  `json:"error"`
}

type List

type List struct {
	Type string `json:"type" rendezvous_value:"list"`
	ID   string `json:"id"`
}

Client sent list message to list nameplates.

type Message

type Message struct {
	Type  string `json:"type" rendezvous_value:"message"`
	ID    string `json:"id"`
	Side  string `json:"side"`
	Phase string `json:"phase"`
	// Body is a hex string encoded json submessage
	Body     string  `json:"body"`
	ServerRX float64 `json:"server_rx"`
	ServerTX float64 `json:"server_tx"`
}

Server sent message message

type Nameplates

type Nameplates struct {
	Type       string `json:"type" rendezvous_value:"nameplates"`
	Nameplates []struct {
		ID string `json:"id"`
	} `json:"nameplates"`
	ServerTX float64 `json:"server_tx"`
}

Server sent nameplates message. The server sends this in response to ListMsg. It contains the list of active nameplates.

type Open

type Open struct {
	Type    string `json:"type" rendezvous_value:"open"`
	ID      string `json:"id"`
	Mailbox string `json:"mailbox"`
}

Client sent open message

type Release

type Release struct {
	Type      string `json:"type" rendezvous_value:"release"`
	ID        string `json:"id"`
	Nameplate string `json:"nameplate"`
}

Client sent release message to release a nameplate.

type ReleasedResp

type ReleasedResp struct {
	Type     string  `json:"type" rendezvous_value:"released"`
	ServerTX float64 `json:"server_tx"`
}

Server sent response to release request.

type Welcome

type Welcome struct {
	Type     string            `json:"type" rendezvous_value:"welcome"`
	Welcome  WelcomeServerInfo `json:"welcome"`
	ServerTX float64           `json:"server_tx"`
}

Server sent wecome message

type WelcomeServerInfo

type WelcomeServerInfo struct {
	MOTD              string `json:"motd"`
	CurrentCLIVersion string `json:"current_cli_version"`
	Error             string `json:"error"`
}