Documentation
¶
Index ¶
- Constants
- Variables
- func GetVersion() string
- func Logger(logger logrus.FieldLogger) gin.HandlerFunc
- func Recovery() gin.HandlerFunc
- func RecoveryWithWriter(out io.Writer) gin.HandlerFunc
- func ZeroConfServer(ctx context.Context, name string, address string)
- type DeviceManager
- func (dm *DeviceManager) AddHandler(manager device.Handler)
- func (dm *DeviceManager) Devices() (map[string][]device.Device, error)
- func (dm *DeviceManager) FindDevice(params *app.Parameter) device.Device
- func (dm *DeviceManager) GetDevice(id string) (device.Device, string)
- func (dm *DeviceManager) ListDevices()
- func (dm *DeviceManager) Managers() []string
- func (dm *DeviceManager) RegisterDevice(data device.RegisterData) (device.Device, error)
- func (dm *DeviceManager) RegisterRoutes(r *gin.Engine, auth *gin.RouterGroup) error
- func (dm *DeviceManager) Run(ctx context.Context, runSocketListener bool) error
- func (dm *DeviceManager) SendAction(dev device.Device, act action.Interface) error
- func (dm *DeviceManager) Start(dev device.Device) error
- func (dm *DeviceManager) Stop(dev device.Device) error
- func (dm *DeviceManager) StopObserver()
- func (dm *DeviceManager) TriggerRefresh()
- type Node
- type NodeManager
- func (nm *NodeManager) ClearAppData(nodeIdentifier manager.NodeIdentifier, deviceId string, ...) error
- func (nm *NodeManager) ConnectionTimeout(nodeIdentifier manager.NodeIdentifier, deviceId string) time.Duration
- func (nm *NodeManager) Control(nodeIdentifier manager.NodeIdentifier, req device.ControlRequest) (device.ControlResponse, error)
- func (nm *NodeManager) Execute(nodeIdentifier manager.NodeIdentifier, deviceId string, data string)
- func (nm *NodeManager) GetManagers(nodeIdentifier manager.NodeIdentifier) (map[string][]device.Device, error)
- func (nm *NodeManager) GetNodes() []manager.NodeIdentifier
- func (nm *NodeManager) GetScreenshot(nodeIdentifier manager.NodeIdentifier, deviceId string) ([]byte, int, int, error)
- func (nm *NodeManager) GetStatus(nodeIdentifier manager.NodeIdentifier) (int, error)
- func (nm *NodeManager) HasFeature(nodeIdentifier manager.NodeIdentifier, deviceId string, feature string) bool
- func (nm *NodeManager) InstallApp(nodeIdentifier manager.NodeIdentifier, deviceId string, ...) error
- func (nm *NodeManager) IsAppInstalled(nodeIdentifier manager.NodeIdentifier, deviceId string, ...) (bool, error)
- func (nm *NodeManager) IsAppUploaded(nodeIdentifier manager.NodeIdentifier, parameter *app.Parameter) (bool, error)
- func (nm *NodeManager) IsConnected(nodeIdentifier manager.NodeIdentifier, deviceId string) bool
- func (nm *NodeManager) IsNodeKnown(nodeIdentifier manager.NodeIdentifier) bool
- func (nm *NodeManager) RegisterNode(nodeIdentifier manager.NodeIdentifier, client manager.RPCClient, ...)
- func (nm *NodeManager) Run(ctx context.Context)
- func (nm *NodeManager) RunNativeScript(nodeIdentifier manager.NodeIdentifier, deviceId string, script []byte)
- func (nm *NodeManager) SendAction(nodeIdentifier manager.NodeIdentifier, deviceId string, action []byte)
- func (nm *NodeManager) StartApp(nodeIdentifier manager.NodeIdentifier, deviceId string, ...) error
- func (nm *NodeManager) StartDevice(nodeIdentifier manager.NodeIdentifier, deviceId string) error
- func (nm *NodeManager) StartRecording(nodeIdentifier manager.NodeIdentifier, deviceId string, path string) error
- func (nm *NodeManager) StartVideoStream(nodeIdentifier manager.NodeIdentifier, req device.VideoStreamRequest) error
- func (nm *NodeManager) StopApp(nodeIdentifier manager.NodeIdentifier, deviceId string, ...) error
- func (nm *NodeManager) StopDevice(nodeIdentifier manager.NodeIdentifier, deviceId string) error
- func (nm *NodeManager) StopRecording(nodeIdentifier manager.NodeIdentifier, deviceId string) error
- func (nm *NodeManager) UninstallApp(nodeIdentifier manager.NodeIdentifier, deviceId string, ...) error
- func (nm *NodeManager) UploadApp(ctx context.Context, nodeIdentifier manager.NodeIdentifier, ...) error
- type NodeStatus
- type Recorder
- type Service
- func (s *Service) AddEndpoint(endpoint endpoints.ServiceEndpoint) error
- func (s *Service) RegisterDeviceHandler(masterUrl string)
- func (s *Service) RegisterHooks(hooksCfgs []config.Hook)
- func (s *Service) RunMaster(nodeManager *NodeManager, sessionManager *SessionManager) error
- func (s *Service) RunNode(handler *node.ReconnectHandler) error
- type Session
- func (s *Session) Close() error
- func (s *Session) DeviceDisconnected()
- func (s *Session) GetActionTimeout() time.Time
- func (s *Session) GetAppParameter() *app.Parameter
- func (s *Session) GetDevice() device.Device
- func (s *Session) GetDeviceLock() *manager.DeviceLock
- func (s *Session) GetLastAccess() time.Time
- func (s *Session) GetLogger() *logrus.Entry
- func (s *Session) GetSessionID() string
- func (s *Session) GetStorage() manager.Storage
- func (s *Session) HandleDisconnect()
- func (s *Session) SetActionTimeout(timeout time.Duration)
- func (s *Session) SetDeviceLock(lock *manager.DeviceLock)
- func (s *Session) SetLastAccess(t time.Time)
- func (s *Session) WaitForConnection() error
- type SessionManager
- func (s *SessionManager) AddSession(session manager.Session)
- func (s *SessionManager) CreateNewSession(log *logrus.Entry, properties *device.Properties, appParameter *app.Parameter) manager.Session
- func (s *SessionManager) GetSession(sessionID string) (manager.Session, error)
- func (s *SessionManager) GetSessionDetails(sessionID string) manager.Session
- func (s *SessionManager) GetSessions() []manager.Session
- func (s *SessionManager) Run(ctx context.Context)
- func (s *SessionManager) StopSession(session manager.Session) error
- type SessionStorage
Constants ¶
View Source
const ( NodeConnectionTimeout = 5 * time.Minute NodeHealthCheckInterval = 5 * time.Second )
View Source
const (
DeviceConnectionTimeout = 5 * time.Minute
)
View Source
const (
SessionTimeout = 1 * time.Minute
)
Variables ¶
View Source
var ( DEVICE_CONNECTION_TIMEOUT = 30 * time.Second CONNECTION_TIMEOUT = fmt.Errorf("connection timeout") ActionTimeout = 20 * time.Second )
View Source
var ErrNodeNotConnected = fmt.Errorf("node not connected")
View Source
var ErrNodeNotFound = fmt.Errorf("node not found")
View Source
var (
UnknownSessionError = fmt.Errorf("unknown session")
)
Functions ¶
func GetVersion ¶
func GetVersion() string
func Logger ¶
func Logger(logger logrus.FieldLogger) gin.HandlerFunc
func Recovery ¶
func Recovery() gin.HandlerFunc
Recovery returns a middleware that recovers from any panics and writes a 500 if there was one.
func RecoveryWithWriter ¶
func RecoveryWithWriter(out io.Writer) gin.HandlerFunc
RecoveryWithWriter returns a middleware for a given writer that recovers from any panics and writes a 500 if there was one.
Types ¶
type DeviceManager ¶
type DeviceManager struct {
// contains filtered or unexported fields
}
func NewDeviceManager ¶
func NewDeviceManager(logger *logrus.Logger, service config.Service) *DeviceManager
func (*DeviceManager) AddHandler ¶
func (dm *DeviceManager) AddHandler(manager device.Handler)
func (*DeviceManager) Devices ¶
func (dm *DeviceManager) Devices() (map[string][]device.Device, error)
func (*DeviceManager) FindDevice ¶
func (dm *DeviceManager) FindDevice(params *app.Parameter) device.Device
func (*DeviceManager) GetDevice ¶
func (dm *DeviceManager) GetDevice(id string) (device.Device, string)
func (*DeviceManager) ListDevices ¶
func (dm *DeviceManager) ListDevices()
func (*DeviceManager) Managers ¶ added in v1.0.0
func (dm *DeviceManager) Managers() []string
func (*DeviceManager) RegisterDevice ¶
func (dm *DeviceManager) RegisterDevice(data device.RegisterData) (device.Device, error)
func (*DeviceManager) RegisterRoutes ¶ added in v1.0.0
func (dm *DeviceManager) RegisterRoutes(r *gin.Engine, auth *gin.RouterGroup) error
func (*DeviceManager) Run ¶
func (dm *DeviceManager) Run(ctx context.Context, runSocketListener bool) error
func (*DeviceManager) SendAction ¶
func (*DeviceManager) StopObserver ¶
func (dm *DeviceManager) StopObserver()
func (*DeviceManager) TriggerRefresh ¶ added in v1.0.4
func (dm *DeviceManager) TriggerRefresh()
type NodeManager ¶ added in v1.0.0
type NodeManager struct {
// contains filtered or unexported fields
}
func NewNodeManager ¶ added in v1.0.0
func NewNodeManager(logger *logrus.Logger, db *gorm.DB) *NodeManager
func (*NodeManager) ClearAppData ¶ added in v1.1.0
func (nm *NodeManager) ClearAppData(nodeIdentifier manager.NodeIdentifier, deviceId string, parameter *app.Parameter) error
func (*NodeManager) ConnectionTimeout ¶ added in v1.0.0
func (nm *NodeManager) ConnectionTimeout(nodeIdentifier manager.NodeIdentifier, deviceId string) time.Duration
func (*NodeManager) Control ¶ added in v1.1.0
func (nm *NodeManager) Control(nodeIdentifier manager.NodeIdentifier, req device.ControlRequest) (device.ControlResponse, error)
func (*NodeManager) Execute ¶ added in v1.0.0
func (nm *NodeManager) Execute(nodeIdentifier manager.NodeIdentifier, deviceId string, data string)
func (*NodeManager) GetManagers ¶ added in v1.0.0
func (nm *NodeManager) GetManagers(nodeIdentifier manager.NodeIdentifier) (map[string][]device.Device, error)
func (*NodeManager) GetNodes ¶ added in v1.0.0
func (nm *NodeManager) GetNodes() []manager.NodeIdentifier
func (*NodeManager) GetScreenshot ¶ added in v1.0.0
func (nm *NodeManager) GetScreenshot(nodeIdentifier manager.NodeIdentifier, deviceId string) ([]byte, int, int, error)
func (*NodeManager) GetStatus ¶ added in v1.0.0
func (nm *NodeManager) GetStatus(nodeIdentifier manager.NodeIdentifier) (int, error)
func (*NodeManager) HasFeature ¶ added in v1.0.0
func (nm *NodeManager) HasFeature(nodeIdentifier manager.NodeIdentifier, deviceId string, feature string) bool
func (*NodeManager) InstallApp ¶ added in v1.0.0
func (nm *NodeManager) InstallApp(nodeIdentifier manager.NodeIdentifier, deviceId string, parameter *app.Parameter) error
func (*NodeManager) IsAppInstalled ¶ added in v1.0.0
func (nm *NodeManager) IsAppInstalled(nodeIdentifier manager.NodeIdentifier, deviceId string, parameter *app.Parameter) (bool, error)
device Actions
func (*NodeManager) IsAppUploaded ¶ added in v1.0.0
func (nm *NodeManager) IsAppUploaded(nodeIdentifier manager.NodeIdentifier, parameter *app.Parameter) (bool, error)
func (*NodeManager) IsConnected ¶ added in v1.0.0
func (nm *NodeManager) IsConnected(nodeIdentifier manager.NodeIdentifier, deviceId string) bool
func (*NodeManager) IsNodeKnown ¶ added in v1.0.0
func (nm *NodeManager) IsNodeKnown(nodeIdentifier manager.NodeIdentifier) bool
func (*NodeManager) RegisterNode ¶ added in v1.0.0
func (nm *NodeManager) RegisterNode(nodeIdentifier manager.NodeIdentifier, client manager.RPCClient, hostname, address, operationSystem, environment string, port int32, managers []string)
func (*NodeManager) Run ¶ added in v1.0.0
func (nm *NodeManager) Run(ctx context.Context)
func (*NodeManager) RunNativeScript ¶ added in v1.0.0
func (nm *NodeManager) RunNativeScript(nodeIdentifier manager.NodeIdentifier, deviceId string, script []byte)
func (*NodeManager) SendAction ¶ added in v1.0.0
func (nm *NodeManager) SendAction(nodeIdentifier manager.NodeIdentifier, deviceId string, action []byte)
func (*NodeManager) StartApp ¶ added in v1.0.0
func (nm *NodeManager) StartApp(nodeIdentifier manager.NodeIdentifier, deviceId string, config *device.DeviceConfig, parameter *app.Parameter, sessionId string, nodeUrl string) error
func (*NodeManager) StartDevice ¶ added in v1.0.0
func (nm *NodeManager) StartDevice(nodeIdentifier manager.NodeIdentifier, deviceId string) error
Manager Actions
func (*NodeManager) StartRecording ¶ added in v1.0.0
func (nm *NodeManager) StartRecording(nodeIdentifier manager.NodeIdentifier, deviceId string, path string) error
func (*NodeManager) StartVideoStream ¶ added in v1.1.0
func (nm *NodeManager) StartVideoStream(nodeIdentifier manager.NodeIdentifier, req device.VideoStreamRequest) error
func (*NodeManager) StopApp ¶ added in v1.0.0
func (nm *NodeManager) StopApp(nodeIdentifier manager.NodeIdentifier, deviceId string, parameter *app.Parameter) error
func (*NodeManager) StopDevice ¶ added in v1.0.0
func (nm *NodeManager) StopDevice(nodeIdentifier manager.NodeIdentifier, deviceId string) error
func (*NodeManager) StopRecording ¶ added in v1.0.0
func (nm *NodeManager) StopRecording(nodeIdentifier manager.NodeIdentifier, deviceId string) error
func (*NodeManager) UninstallApp ¶ added in v1.0.0
func (nm *NodeManager) UninstallApp(nodeIdentifier manager.NodeIdentifier, deviceId string, parameter *app.Parameter) error
func (*NodeManager) UploadApp ¶ added in v1.0.0
func (nm *NodeManager) UploadApp(ctx context.Context, nodeIdentifier manager.NodeIdentifier, parameter *app.Parameter) error
type NodeStatus ¶ added in v1.0.0
type NodeStatus int
const ( NodeStatusDisconnected NodeStatus = iota NodeStatusConnected )
type Recorder ¶
type Recorder struct {
Storage *SessionStorage
Device device.Device
}
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
func NewService ¶
func (*Service) AddEndpoint ¶
func (s *Service) AddEndpoint(endpoint endpoints.ServiceEndpoint) error
func (*Service) RegisterDeviceHandler ¶ added in v1.0.0
func (*Service) RegisterHooks ¶
func (*Service) RunMaster ¶
func (s *Service) RunMaster(nodeManager *NodeManager, sessionManager *SessionManager) error
type Session ¶
type Session struct {
SessionID string
LastAccess time.Time
Lock *manager.DeviceLock
Recorder *Recorder
DeviceProperties *device.Properties
AppParameter *app.Parameter
XmlDocument *xmlquery.Node
Storage manager.Storage
// contains filtered or unexported fields
}
func (*Session) DeviceDisconnected ¶
func (s *Session) DeviceDisconnected()
func (*Session) GetActionTimeout ¶
func (*Session) GetAppParameter ¶
func (*Session) GetDeviceLock ¶
func (s *Session) GetDeviceLock() *manager.DeviceLock
func (*Session) GetLastAccess ¶
func (*Session) GetSessionID ¶
func (*Session) GetStorage ¶
func (*Session) HandleDisconnect ¶
func (s *Session) HandleDisconnect()
func (*Session) SetActionTimeout ¶
func (*Session) SetDeviceLock ¶
func (s *Session) SetDeviceLock(lock *manager.DeviceLock)
func (*Session) SetLastAccess ¶
func (*Session) WaitForConnection ¶
type SessionManager ¶
type SessionManager struct {
// contains filtered or unexported fields
}
func NewSessionManager ¶
func NewSessionManager(logger *logrus.Logger, deviceManager *DeviceManager) *SessionManager
func (*SessionManager) AddSession ¶
func (s *SessionManager) AddSession(session manager.Session)
func (*SessionManager) CreateNewSession ¶
func (s *SessionManager) CreateNewSession(log *logrus.Entry, properties *device.Properties, appParameter *app.Parameter) manager.Session
func (*SessionManager) GetSession ¶
func (s *SessionManager) GetSession(sessionID string) (manager.Session, error)
func (*SessionManager) GetSessionDetails ¶
func (s *SessionManager) GetSessionDetails(sessionID string) manager.Session
func (*SessionManager) GetSessions ¶
func (s *SessionManager) GetSessions() []manager.Session
func (*SessionManager) Run ¶
func (s *SessionManager) Run(ctx context.Context)
func (*SessionManager) StopSession ¶
func (s *SessionManager) StopSession(session manager.Session) error
type SessionStorage ¶
type SessionStorage struct {
Path string
SessionID string
// contains filtered or unexported fields
}
func NewSessionStorage ¶
func NewSessionStorage(Path, SessionID string) *SessionStorage
func (*SessionStorage) Close ¶
func (s *SessionStorage) Close() error
func (*SessionStorage) GetPath ¶
func (s *SessionStorage) GetPath() string
func (*SessionStorage) RemoteDeviceLog ¶
func (s *SessionStorage) RemoteDeviceLog(line string)
func (*SessionStorage) StoreImage ¶
func (s *SessionStorage) StoreImage(content []byte) (string, error)
func (*SessionStorage) StoreSceneGraph ¶
func (s *SessionStorage) StoreSceneGraph(data []byte) (string, error)
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package control provides interactive (live) device control on top of the device layer: native input, screenshots, logs, app lifecycle and app-level actions through the Unity plugin.
|
Package control provides interactive (live) device control on top of the device layer: native input, screenshots, logs, app lifecycle and app-level actions through the Unity plugin. |
|
jsonrpc
Package jsonrpc implements a JSON-RPC 1.0 ClientCodec and ServerCodec for the rpc package.
|
Package jsonrpc implements a JSON-RPC 1.0 ClientCodec and ServerCodec for the rpc package. |
|
Package videostream moves device video streams over websockets: from a node to the master, and from the master to the browser.
|
Package videostream moves device video streams over websockets: from a node to the master, and from the master to the browser. |
|
videostreamtest
Package videostreamtest has a fake device.VideoStream for tests.
|
Package videostreamtest has a fake device.VideoStream for tests. |
Click to show internal directories.
Click to hide internal directories.