channel

Documentation

Overview

Package channel provides implementations of the chirp.Channel interface.

Index

• func Direct() (A, B chirp.Channel)
• func NetConn(c chirp.Channel) net.Conn
• type IOChannel
  • func IO(r io.Reader, wc io.WriteCloser) IOChannel
  • func (c IOChannel) Close() error
  • func (c IOChannel) NetConn() net.Conn
  • func (c IOChannel) Recv() (chirp.Packet, error)
  • func (c IOChannel) Send(pkt chirp.Packet) error
• type NetConner
• type Pipe
  • func ConnectPipe(r, w *os.File) *Pipe
  • func NewPipe() (A, B *Pipe, _ error)
  • func (c *Pipe) Close() error
  • func (c *Pipe) Files() (r, w *os.File)
  • func (c *Pipe) Recv() (chirp.Packet, error)
  • func (c *Pipe) Send(pkt chirp.Packet) error

Functions

func Direct

func Direct() (A, B chirp.Channel)

Direct constructs a connected pair of in-memory channels that pass packets directly without encoding into binary. Packets sent to A are received by B and vice versa.

func NetConn

func NetConn(c chirp.Channel) net.Conn

NetConn returns the net.Conn impementation underlying c, if one is available, or else nil. If c implements NetConner its corresponding method will be called to locate a connection. If c == nil, NetConn reports nil.

The chirp.Channel retains ownership of any net.Conn that is returned. Note that sending or receiving data, or otherwise changing the state of the resulting connection may invalidate assumptions of the channel that uses it.

Types

type IOChannel

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

An IOChannel sends and receives packets on a reader and a writer.

func IO

func IO(r io.Reader, wc io.WriteCloser) IOChannel

IO constructs a channel that receives from r and sends to wc.

func (IOChannel) Close

func (c IOChannel) Close() error

Close implements a method of the chirp.Channel interface.

func (IOChannel) NetConn

func (c IOChannel) NetConn() net.Conn

NetConn implements the optional NetConner interface. It returns a non-nil value if c was constructed with a net.Conn as its writer.

func (IOChannel) Recv

func (c IOChannel) Recv() (chirp.Packet, error)

Recv implements a method of the chirp.Channel interface.

func (IOChannel) Send

func (c IOChannel) Send(pkt chirp.Packet) error

Send implements a method of the chirp.Channel interface.

type NetConner

type NetConner interface {
	NetConn() net.Conn
}

NetConner is an optional interface that a chirp.Channel may implement to expose an underlying net.Conn used by its implementation. The method should report nil if its receiver does not have a net.Conn.

type Pipe

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

A Pipe implements the chirp.Channel interface around an os.Pipe.

func ConnectPipe

func ConnectPipe(r, w *os.File) *Pipe

ConnectPipe constructs a new Pipe wrapping the specified files.

func NewPipe

func NewPipe() (A, B *Pipe, _ error)

NewPipe establishes a connected pair of os.Pipe for a pair of peers, and returns Pipe values wrapping them. Sends to A are received by B and vice versa. Each call to NewPipe returns a distinct pair of pipes.

func (*Pipe) Close

func (c *Pipe) Close() error

Close implements part of the chirp.Channel interface.

func (*Pipe) Files

func (c *Pipe) Files() (r, w *os.File)

Files returns the underlying os.File values used by c.

func (*Pipe) Recv

func (c *Pipe) Recv() (chirp.Packet, error)

Recv implements part of the chirp.Channel interface.

func (*Pipe) Send

func (c *Pipe) Send(pkt chirp.Packet) error

Send implements part of the chirp.Channel interface.