czar

Documentation

Index

• type Client
  • func NewClient(server, cipher string) *Client
  • func (c *Client) Close() error
  • func (c *Client) Dial(ctx *daze.Context, network string, address string) (io.ReadWriteCloser, error)
  • func (c *Client) Run()
• type Err
  • func (a *Err) Get() error
  • func (a *Err) Put(err error)
• type Mux
  • func NewMux(conn net.Conn) *Mux
  • func NewMuxClient(conn net.Conn) *Mux
  • func NewMuxServer(conn net.Conn) *Mux
  • func (m *Mux) Accept() chan *Stream
  • func (m *Mux) Close() error
  • func (m *Mux) Open() (*Stream, error)
  • func (m *Mux) Spawn()
  • func (m *Mux) Write(priority int, b []byte) (int, error)
• type Server
  • func NewServer(listen string, cipher string) *Server
  • func (s *Server) Close() error
  • func (s *Server) Run() error
  • func (s *Server) Serve(ctx *daze.Context, cli io.ReadWriteCloser) error
• type Stream
  • func NewStream(idx uint8, mux *Mux) *Stream
  • func (s *Stream) Close() error
  • func (s *Stream) Read(p []byte) (int, error)
  • func (s *Stream) Write(p []byte) (int, error)

Types

type Client

type Client struct {
	Cipher []byte
	Server string
	Mux    chan *Mux
}

Client implemented the czar protocol.

func NewClient

func NewClient(server, cipher string) *Client

NewClient returns a new Client.

func (*Client) Close

func (c *Client) Close() error

func (*Client) Dial

func (c *Client) Dial(ctx *daze.Context, network string, address string) (io.ReadWriteCloser, error)

Dial connects to the address on the named network.

func (*Client) Run

func (c *Client) Run()

Run creates an establish connection to czar server.

type Err

type Err struct {
	sync.Mutex // Guards following
	// contains filtered or unexported fields
}

Err is an object that will only store an error once.

func (*Err) Get

func (a *Err) Get() error

Get an error from Err.

func (*Err) Put

func (a *Err) Put(err error)

Put an error into Err.

type Mux

type Mux struct {
	// contains filtered or unexported fields
}

Mux is used to wrap a reliable ordered connection and to multiplex it into multiple streams.

func NewMux

func NewMux(conn net.Conn) *Mux

NewMux returns a new Mux.

func NewMuxClient

func NewMuxClient(conn net.Conn) *Mux

NewMuxClient returns a new MuxClient.

func NewMuxServer

func NewMuxServer(conn net.Conn) *Mux

NewMuxServer returns a new MuxServer.

func (*Mux) Accept

func (m *Mux) Accept() chan *Stream

Accept is used to block until the next available stream is ready to be accepted.

func (*Mux) Close

func (m *Mux) Close() error

Close closes the connection. Any blocked Read or Write operations will be unblocked and return errors.

func (*Mux) Open

func (m *Mux) Open() (*Stream, error)

Open is used to create a new stream as a net.Conn.

func (*Mux) Spawn

func (m *Mux) Spawn()

Spawn continues to receive data until a fatal error is encountered.

func (*Mux) Write

func (m *Mux) Write(priority int, b []byte) (int, error)

Write writes data to the connection. The code implements a simple priority write using two locks.

type Server

type Server struct {
	Listen string
	Cipher []byte
	Closer io.Closer
}

Server implemented the czar protocol.

func NewServer

func NewServer(listen string, cipher string) *Server

NewServer returns a new Server.

func (*Server) Close

func (s *Server) Close() error

Close listener.

func (*Server) Run

func (s *Server) Run() error

Run it.

func (*Server) Serve

func (s *Server) Serve(ctx *daze.Context, cli io.ReadWriteCloser) error

Serve incoming connections. Parameter cli will be closed automatically when the function exits.

type Stream

type Stream struct {
	// contains filtered or unexported fields
}

A Stream managed by the multiplexer.

func NewStream

func NewStream(idx uint8, mux *Mux) *Stream

NewStream returns a new Stream.

func (*Stream) Close

func (s *Stream) Close() error

Close implements io.Closer.

func (*Stream) Read

func (s *Stream) Read(p []byte) (int, error)

Read implements io.Reader.

func (*Stream) Write

func (s *Stream) Write(p []byte) (int, error)

Write implements io.Writer.