client

Documentation

Index

• Constants
• func HandleEvents()
• func HandleIncomingMessages(connection *websocket.Conn)
• func HandleSendEvents(connection *websocket.Conn)
• func HandleWebsocketClose(message ControllerMessage)
• func InitClient() *websocket.Conn
• func Main()
• func ScanFile()
• func SendIdentity(connection *websocket.Conn, clientId string)
• type ClientOptions
  • func InitOptions() *ClientOptions
• type ControllerMessage
• type IdentityMessage
• type LogMessage
• type Message
  • func NewMessage(message []byte) (Message, error)
  • func (message Message) MarshalLogObject(encoder zapcore.ObjectEncoder) error
  • func (m Message) MarshalPayload() ([]byte, error)
  • func (m Message) ToSubscriberConnectedMessage() (SubscriberConnectedMessage, error)
• type SubscriberConnectedMessage

Constants

const (
	EVENT_IDENTITY       = "identity"
	EVENT_SUBSCRIBER_ACK = "subscriber_ack"
)

const (
	DEFAULT_ENVIRONMENT = "prod"
	DEFAULT_DOMAIN      = "localhost:3000"
	DEFAULT_LOG_LEVEL   = "error"
)

Functions

func HandleEvents

func HandleEvents()

func HandleIncomingMessages

func HandleIncomingMessages(connection *websocket.Conn)

Needed to receive server events Right now we do nothing, but its here to avoid errors on the protocol

func HandleSendEvents

func HandleSendEvents(connection *websocket.Conn)

func HandleWebsocketClose

func HandleWebsocketClose(message ControllerMessage)

func InitClient

func InitClient() *websocket.Conn

func Main

func Main()

func ScanFile

func ScanFile()

func SendIdentity

func SendIdentity(connection *websocket.Conn, clientId string)

Types

type ClientOptions

type ClientOptions struct {
	Env          string
	Domain       *utils.Domain
	LogLevel     zapcore.Level
	PeerId       string
	Listen       bool
	Output       bool
	UrlClipboard bool
}

func InitOptions

func InitOptions() *ClientOptions

type ControllerMessage

type ControllerMessage struct {
	Message    string
	Error      error
	Connection *websocket.Conn
}

type IdentityMessage

type IdentityMessage struct {
	PeerId      string `json:"peerId"`
	Broadcaster bool   `json:"broadcaster"`
	Subscriber  bool   `json:"subscriber"`
}

type LogMessage

type LogMessage struct {
	Line string `json:"line"`
}

type Message

type Message struct {
	Id      string      `json:"id"`
	Payload interface{} `json:"payload"`
	Event   string      `json:"event"`
}

func NewMessage

func NewMessage(message []byte) (Message, error)

func (Message) MarshalLogObject

func (message Message) MarshalLogObject(encoder zapcore.ObjectEncoder) error

func (Message) MarshalPayload

func (m Message) MarshalPayload() ([]byte, error)

func (Message) ToSubscriberConnectedMessage

func (m Message) ToSubscriberConnectedMessage() (SubscriberConnectedMessage, error)

type SubscriberConnectedMessage

type SubscriberConnectedMessage struct {
	Connected bool `json:"connected"`
}