gmclient

Documentation

Index

• Constants
• type ClientI
  • func NewWebSocketClient(options *options.LocalControllerOptions) ClientI
• type Input
• type Message
• type MessageHeader
• type MessageResourceHandler
• type Model
• type Output
• type UpstreamMessage
• type WSConnection

Constants

const (
	// InsertOperation is the insert value
	InsertOperation = "insert"
	// DeleteOperation is the delete value
	DeleteOperation = "delete"
	// StatusOperation is the status value
	StatusOperation = "status"
)

const (
	// RetryCount is count of retrying to connecting to global manager
	RetryCount = 5
	// RetryConnectIntervalSeconds is interval time of retrying to connecting to global manager
	RetryConnectIntervalSeconds = 5
	// MessageChannelCacheSize is size of channel cache
	MessageChannelCacheSize = 100
)

Types

type ClientI

type ClientI interface {
	Start() error
	WriteMessage(messageBody interface{}, messageHeader MessageHeader) error
	Subscribe(m MessageResourceHandler) error
}

func NewWebSocketClient

func NewWebSocketClient(options *options.LocalControllerOptions) ClientI

NewWebSocketClient creates client

type Input

type Input struct {
	Models       []Model `json:"models,omitempty"`
	DataURL      string  `json:"dataURL,omitempty"`
	DataIndexURL string  `json:"dataIndexURL,omitempty"`
	OutputDir    string  `json:"outputDir,omitempty"`
}

type Message

type Message struct {
	Header  MessageHeader `json:"header"`
	Content []byte        `json:"content"`
}

Message defines message between LC and GM

type MessageHeader

type MessageHeader = messagetypes.MessageHeader

MessageHeader defines the header between LC and GM

type MessageResourceHandler

type MessageResourceHandler interface {
	GetName() string
	Insert(*Message) error
	Delete(*Message) error
}

type Model

type Model = runtime.Model

type Output

type Output struct {
	// All the TaskInfo has been written to "Model"
	Models    []map[string]interface{} `json:"models"`
	OwnerInfo map[string]interface{}   `json:"ownerInfo"`
}

type UpstreamMessage

type UpstreamMessage struct {
	Phase  string  `json:"phase"`
	Status string  `json:"status"`
	Input  *Input  `json:"input,omitempty"`
	Output *Output `json:"output"`
}

UpstreamMessage defines send message content to GM

type WSConnection

type WSConnection struct {
	WSConn *websocket.Conn
}

WSConnection defines conn