screen

Documentation

Index

• type Client
  • func NewClient(conn *websocket.Conn) *Client
  • func (c *Client) Close()
  • func (c *Client) HandleInput()
  • func (c *Client) Read(p []byte) (n int, err error)
  • func (c *Client) ReadFromWS(p []byte) (n int, err error)
  • func (c *Client) Send(prefix byte, p []byte) (err error)
  • func (c *Client) Write(p []byte) (n int, err error)
• type Manager
  • func NewManager() *Manager
  • func (m *Manager) ChangeScreen(c *Client, s *Screen) error
  • func (m *Manager) DetachClientFromAllScreens(c *Client)
  • func (m *Manager) GetDefaultScreen() *Screen
  • func (m *Manager) GetScreenByID(id int) (bool, *Screen)
  • func (m *Manager) GetScreenByTitle(title string) (bool, *Screen)
  • func (m *Manager) RemoveScreen(s *Screen) error
• type Screen
  • func New(rows, columns int) *Screen
  • func (s *Screen) AttachClient(c *Client, writePermission bool) error
  • func (s *Screen) CursorPos() (rows, columns int)
  • func (s *Screen) DetachClient(c *Client) error
  • func (s *Screen) GetScreenAsANSI() []byte
  • func (s *Screen) Read(p []byte) (n int, err error)
  • func (s *Screen) RemoveAttachedClient(c *Client)
  • func (s *Screen) Resize(rows, columns int)
  • func (s *Screen) Send(prefix byte, p []byte) (err error)
  • func (s *Screen) Size() (rows, columns int)
  • func (s *Screen) Write(p []byte) (n int, err error)
• type ScreenClientProperties

Types

type Client

type Client struct {
	IP        string
	Nick      string
	SessionID string

	CurrentScreen *Screen
	// contains filtered or unexported fields
}

func NewClient

func NewClient(conn *websocket.Conn) *Client

func (*Client) Close

func (c *Client) Close()

func (*Client) HandleInput

func (c *Client) HandleInput()

handle client input

func (*Client) Read

func (c *Client) Read(p []byte) (n int, err error)

Read reads from the stream

func (*Client) ReadFromWS

func (c *Client) ReadFromWS(p []byte) (n int, err error)

ReadFromWS reads from the websocket

func (*Client) Send

func (c *Client) Send(prefix byte, p []byte) (err error)

Send sends a message to the client using the stream

func (*Client) Write

func (c *Client) Write(p []byte) (n int, err error)

Write writes to the stream

type Manager

type Manager struct {
	Screens []*Screen
}

func NewManager

func NewManager() *Manager

func (*Manager) ChangeScreen

func (m *Manager) ChangeScreen(c *Client, s *Screen) error

change current screen

func (*Manager) DetachClientFromAllScreens

func (m *Manager) DetachClientFromAllScreens(c *Client)

detach a client from all screens

func (*Manager) GetDefaultScreen

func (m *Manager) GetDefaultScreen() *Screen

get default screen

func (*Manager) GetScreenByID

func (m *Manager) GetScreenByID(id int) (bool, *Screen)

get screen by id

func (*Manager) GetScreenByTitle

func (m *Manager) GetScreenByTitle(title string) (bool, *Screen)

get screen by Title

func (*Manager) RemoveScreen

func (m *Manager) RemoveScreen(s *Screen) error

remove a screen

type Screen

type Screen struct {
	Title string

	Clients           []*Client // Attached clients
	ClientsProperties map[*Client]*ScreenClientProperties
	Stream            *stream.Stream

	Input io.Writer // receive input (stdin) from attached clients and other sources
	// contains filtered or unexported fields
}

func New

func New(rows, columns int) *Screen

func (*Screen) AttachClient

func (s *Screen) AttachClient(c *Client, writePermission bool) error

attach a client to a screen

func (*Screen) CursorPos

func (s *Screen) CursorPos() (rows, columns int)

CursorPos() returns the cursor position

func (*Screen) DetachClient

func (s *Screen) DetachClient(c *Client) error

detach a client from a screen

func (*Screen) GetScreenAsANSI

func (s *Screen) GetScreenAsANSI() []byte

GetScreenAsANSI returns the screen as ANSI

func (*Screen) Read

func (s *Screen) Read(p []byte) (n int, err error)

func (*Screen) RemoveAttachedClient

func (s *Screen) RemoveAttachedClient(c *Client)

func (*Screen) Resize

func (s *Screen) Resize(rows, columns int)

Resize screen

func (*Screen) Send

func (s *Screen) Send(prefix byte, p []byte) (err error)

func (*Screen) Size

func (s *Screen) Size() (rows, columns int)

Get screen size

func (*Screen) Write

func (s *Screen) Write(p []byte) (n int, err error)

Writer interface

type ScreenClientProperties

type ScreenClientProperties struct {
	WritePermission bool
}