Documentation
¶
Index ¶
Constants ¶
const UserClosedStreamIndex = -1
UserClosedStreamIndex is the maximum number of inbound or outbound streams supported by any one lib.User
const UserMaxStreams = 64
UserMaxStreams is the character prefix which identifies a user ID.
Variables ¶
This section is empty.
Functions ¶
func ResetErrors ¶
func ResetErrors() error
ResetErrors resets guacamole runtime error and returns the former error message
Types ¶
type Client ¶
type Client struct {
ID string
// contains filtered or unexported fields
}
Client is a guacamole client container
func (*Client) InitLogLevel ¶
InitLogLevel initialize guacamole's libguac maximum log level
func (*Client) LoadProtocolPlugin ¶
LoadProtocolPlugin initializes the given guac_client using the initialization routine provided by the plugin corresponding to the named protocol. This will automatically invoke guac_client_init within the plugin for the given protocol.
Note that the connection will likely not be established until the first user (the "owner") is added to the client.
type ClientMouse ¶
type ClientMouse int
ClientMouse ...
const ( ClientMouseLeft ClientMouse = 0x01 ClientMouseMiddle ClientMouse = 0x02 ClientMouseRight ClientMouse = 0x04 ClientMouseScrollUp ClientMouse = 0x08 ClientMouseScrollDown ClientMouse = 0x10 )
ClientMouse constants
type Socket ¶
type Socket struct {
// contains filtered or unexported fields
}
Socket is a wrapper of given open file descriptor
func NewSocket ¶
NewSocket allocates and initialize a new guac_socket object with given open file descriptor. The file descriptor will be automatically closed when the allocated guac_socket is freed.
If an error occurs while allocating the guac_socket object, guac_error will be returned as error.
func (*Socket) Close ¶
func (s *Socket) Close()
Close closes the Socket and all associated resources.
type User ¶
type User struct {
ID string
// contains filtered or unexported fields
}
User is the representation of a physical connection within a larger logical connection which may be shared. Logical connections are represented by guac_client.
func (*User) Close ¶
func (u *User) Close()
Close frees the user and detach the association to the attached client
func (*User) HandleConnection ¶
func (u *User) HandleConnection(done chan struct{})
HandleConnection handles all I/O for the portion of a user's Occamy connection without the handshake process. This function blocks until the connection/user is aborted or the user disconnects.
Source Files