socket

Documentation

Index

• Constants
• func CommandHeadersToMessage(headers CommandHeader) string
• func CommandToMessage(command *Command) ([]byte, error)
• type Command
  • func NewCommandFromMessage(message []byte) (*Command, error)
• type CommandHeader
  • func NewCommandHeadersFromMessage(message string) CommandHeader
• type Exec
  • func NewExecFromCommandPayload(payload []string) *Exec
• type ExecType
• type Signal

Constants

const (
	ConnHost = "localhost"
	ConnType = "tcp"
)

const for connection

const (
	SignalConnect Signal = "SIGNAL_CONNECT"
	SignalExec           = "SIGNAL_EXEC"
	SignalSuccess        = "SIGNAL_SUCCESS"
	SignalError          = "SIGNAL_ERROR"
)

const for signal type

const (
	ExecSet    ExecType = "EXEC_SET"
	ExecGet             = "EXEC_GET"
	ExecDel             = "EXEC_DEL"
	ExecExp             = "EXEC_EXP"
	ExecExists          = "EXEC_EXISTS"
)

const for execution types

Functions

func CommandHeadersToMessage

func CommandHeadersToMessage(headers CommandHeader) string

CommandHeadersToMessage returns message built from given headers

func CommandToMessage

func CommandToMessage(command *Command) ([]byte, error)

CommandToMessage generate message string from given command

Types

type Command

type Command struct {
	Type    Signal        `json:"t"`
	User    string        `json:"u"`
	Payload []string      `json:"p,omitempty"`
	Headers CommandHeader `json:"h,omitempty"`
}

Command struct for client and server data

func NewCommandFromMessage

func NewCommandFromMessage(message []byte) (*Command, error)

NewCommandFromMessage create command from message string message format: cmd=>uid=>payload=>header

type CommandHeader

type CommandHeader map[string]interface{}

CommandHeader type

func NewCommandHeadersFromMessage

func NewCommandHeadersFromMessage(message string) CommandHeader

NewCommandHeadersFromMessage create command header from given message the message should: EXEC_TYPE:<ExecType>

type Exec

type Exec struct {
	Type ExecType
	Args []string
}

Exec define execution model

func NewExecFromCommandPayload

func NewExecFromCommandPayload(payload []string) *Exec

NewExecFromCommandPayload create exec using command payload

type ExecType

type ExecType string

ExecType type of execution command

const (
	CommandHeaderExecType ExecType = "EXEC_TYPE"
)

const for command header

type Signal

type Signal string

Signal type