Skip to content

Commit

Permalink
Docs: Update docs to reflect the merge with Session
Browse files Browse the repository at this point in the history
  • Loading branch information
deluan committed Nov 21, 2019
1 parent 7f938c2 commit f957cd5
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions client.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,8 @@ var ErrInvalidKeyCode = errors.New("invalid key code")

type OnSyncFunc = func(image image.Image, lastUpdate int64)

// Guacamole protocol client. Given a Session, automatically handles incoming
// and outgoing Guacamole instructions via the provided session, updating its
// display using one or more graphic primitives.
// Guacamole protocol client. Automatically handles incoming and outgoing Guacamole instructions,
// updating its display using one or more graphic primitives.
type Client struct {
session *session
display *display
Expand All @@ -23,7 +22,7 @@ type Client struct {
onSync OnSyncFunc
}

// Creates a new Client with the provided Session and Logger
// NewClient creates a Client and connects it to the guacd server with the provided configuration. Logger is optional
func NewClient(addr string, remoteProtocol string, config map[string]string, logger ...Logger) (*Client, error) {
var log Logger
if len(logger) > 0 {
Expand Down

0 comments on commit f957cd5

Please sign in to comment.