rpc

package module

v0.2.0 Latest Latest Go to latest Published: Mar 23, 2020 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/levelsoftware/golibvncserver

Documentation ¶

Constants ¶

View Source

const HandlerName = "Handler.Execute"

HandlerName provides the name of the method the RPC client should call via the RPC interface.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	Port uint
	// contains filtered or unexported fields
}

Client contains the configuration for RPC client

func (*Client) Close ¶

func (c *Client) Close() (err error)

Close gracefully terminates the underlying RPC client

func (*Client) Execute ¶

func (c *Client) Execute(req Request) (ok bool, msg string, err error)

Execute an RPC request

func (*Client) InitRPC ¶ added in v0.2.0

func (c *Client) InitRPC() (close func() error, err error)

InitRPC initializes the underlying RPC client A close callback is returned that can be deferred if InitRPC succeeds.

type Request ¶

type Request struct {
	Name               RequestType
	StartVNCServerArgs StartVNCServerRequestArgs
	StopVNCServerArgs  StopVNCServerRequestArgs
}

Request identifies what method to call and arguments to pass.

type RequestType ¶

type RequestType string

RequestType indicates the type of request

const (
	// StartVNCServer request
	StartVNCServer RequestType = "Start"
	// StopVNCServer request
	StopVNCServer RequestType = "Stop"
	// IsVNCServerActive request
	IsVNCServerActive RequestType = "IsActive"
)

type Response ¶

type Response struct {
	Ok      bool
	Message string
}

Response informs client about success of request.

type StartVNCServerRequestArgs ¶ added in v0.2.0

type StartVNCServerRequestArgs struct {
	Port   int
	Passwd string
	Shared bool
}

StartVNCServerRequestArgs holds arguments for a StartVNCServer Request. Port is the VNC Server Port Passwd is the VNC Server Password Shared indicates whether the VNC Server allows multiple connections

type StopVNCServerRequestArgs ¶ added in v0.2.0

type StopVNCServerRequestArgs struct {
	DisconnectClients bool
}

StopVNCServerRequestArgs holds arguments for a StopVNCServer Request. DisconnectClients indicates whether the VNC Server should close all client connections when shutting down.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL