pio

Documentation

Index

• Constants
• type Conn
  • func NewConn(r io.Reader, w io.Writer) (c *Conn)
  • func NewConnContext(ctx context.Context, r io.Reader, w io.Writer) (c *Conn)
  • func OsPipe() (c *Conn, br, bw *os.File, err error)
  • func Pipe() (a, b *Conn)
  • func (c *Conn) AddPacket(newer PacketNewer)
  • func (c *Conn) AsStream() (rw io.ReadWriteCloser, err error)
  • func (c *Conn) Ask(p PacketBase) (res PacketBase, err error)
  • func (c *Conn) AskWith(ctx context.Context, p PacketBase) (res PacketBase, err error)
  • func (c *Conn) Close() (err error)
  • func (c *Conn) Context() context.Context
  • func (c *Conn) NewPacket(pid uint32) PacketBase
  • func (c *Conn) Ping() (ping time.Duration, err error)
  • func (c *Conn) PingWith(ctx context.Context) (ping time.Duration, err error)
  • func (c *Conn) PopPacket(pid uint32) (ok bool)
  • func (c *Conn) Send(p PacketBase) (err error)
  • func (c *Conn) Serve() (err error)
  • func (c *Conn) ServeDone() <-chan struct{}
  • func (c *Conn) StreamedDone() <-chan struct{}
• type ConnState
• type EmptyPkt
  • func (EmptyPkt) ParseFrom(encoding.Reader) error
  • func (pkt EmptyPkt) PktId() uint32
  • func (EmptyPkt) WriteTo(encoding.Writer) error
• type EmptyPktAsk
  • func (pkt EmptyPktAsk) Ask() (PacketBase, error)
• type EmptyPktTrigger
  • func (pkt EmptyPktTrigger) Trigger() error
• type Ok
  • func (Ok) ParseFrom(encoding.Reader) error
  • func (Ok) PktId() uint32
  • func (Ok) WriteTo(encoding.Writer) error
• type Packet
  • func NewPktTrigger(id uint32, ontrigger func() error) Packet
• type PacketAsk
  • func NewPktAsk(id uint32, onask func() (PacketBase, error)) PacketAsk
• type PacketBase
  • func NewPkt(id uint32) PacketBase
• type PacketNewer
• type Ping
  • func (p *Ping) Ask() (res PacketBase, err error)
  • func (p *Ping) ParseFrom(r encoding.Reader) (err error)
  • func (*Ping) PktId() uint32
  • func (p *Ping) WriteTo(w encoding.Writer) (err error)
• type Pong
  • func (p *Pong) ParseFrom(r encoding.Reader) (err error)
  • func (*Pong) PktId() uint32
  • func (p *Pong) WriteTo(w encoding.Writer) (err error)

Constants

const (
	NoAsk   byte = 0x00
	SendAsk byte = 0x01
	RecvAsk byte = 0x02
)

Types

type Conn

type Conn struct {
	OnPktNotFound func(id uint32, body encoding.Reader)
	OnParseError  func(pkt PacketBase, err error)
	// contains filtered or unexported fields
}

func NewConn

func NewConn(r io.Reader, w io.Writer) (c *Conn)

func NewConnContext

func NewConnContext(ctx context.Context, r io.Reader, w io.Writer) (c *Conn)

func OsPipe

func OsPipe() (c *Conn, br, bw *os.File, err error)

func Pipe

func Pipe() (a, b *Conn)

func (*Conn) AddPacket

func (c *Conn) AddPacket(newer PacketNewer)

func (*Conn) AsStream

func (c *Conn) AsStream() (rw io.ReadWriteCloser, err error)

func (*Conn) Ask

func (c *Conn) Ask(p PacketBase) (res PacketBase, err error)

func (*Conn) AskWith

func (c *Conn) AskWith(ctx context.Context, p PacketBase) (res PacketBase, err error)

func (*Conn) Close

func (c *Conn) Close() (err error)

func (*Conn) Context

func (c *Conn) Context() context.Context

func (*Conn) NewPacket

func (c *Conn) NewPacket(pid uint32) PacketBase

func (*Conn) Ping

func (c *Conn) Ping() (ping time.Duration, err error)

func (*Conn) PingWith

func (c *Conn) PingWith(ctx context.Context) (ping time.Duration, err error)

func (*Conn) PopPacket

func (c *Conn) PopPacket(pid uint32) (ok bool)

func (*Conn) Send

func (c *Conn) Send(p PacketBase) (err error)

func (*Conn) Serve

func (c *Conn) Serve() (err error)

func (*Conn) ServeDone

func (c *Conn) ServeDone() <-chan struct{}

func (*Conn) StreamedDone

func (c *Conn) StreamedDone() <-chan struct{}

type ConnState

type ConnState int

const (
	ConnInited ConnState = iota
	ConnServing
	ConnPreStream
	ConnStreamed
)

type EmptyPkt

type EmptyPkt struct {
	Id uint32
}

func (EmptyPkt) ParseFrom

func (EmptyPkt) ParseFrom(encoding.Reader) error

func (EmptyPkt) PktId

func (pkt EmptyPkt) PktId() uint32

func (EmptyPkt) WriteTo

func (EmptyPkt) WriteTo(encoding.Writer) error

type EmptyPktAsk

type EmptyPktAsk struct {
	EmptyPkt
	OnAsk func() (PacketBase, error)
}

func (EmptyPktAsk) Ask

func (pkt EmptyPktAsk) Ask() (PacketBase, error)

type EmptyPktTrigger

type EmptyPktTrigger struct {
	EmptyPkt
	OnTrigger func() error
}

func (EmptyPktTrigger) Trigger

func (pkt EmptyPktTrigger) Trigger() error

type Ok

type Ok struct{}

func (Ok) ParseFrom

func (Ok) ParseFrom(encoding.Reader) error

func (Ok) PktId

func (Ok) PktId() uint32

func (Ok) WriteTo

func (Ok) WriteTo(encoding.Writer) error

type Packet

type Packet interface {
	PacketBase
	Trigger() error
}

func NewPktTrigger

func NewPktTrigger(id uint32, ontrigger func() error) Packet

type PacketAsk

type PacketAsk interface {
	PacketBase
	Ask() (PacketBase, error)
}

func NewPktAsk

func NewPktAsk(id uint32, onask func() (PacketBase, error)) PacketAsk

type PacketBase

type PacketBase interface {
	PktId() uint32
	ParseFrom(encoding.Reader) error
	WriteTo(encoding.Writer) error
}

var OkPkt PacketBase = Ok{}

func NewPkt

func NewPkt(id uint32) PacketBase

type PacketNewer

type PacketNewer func() PacketBase

type Ping

type Ping struct {
	Payload uint64
}

func (*Ping) Ask

func (p *Ping) Ask() (res PacketBase, err error)

func (*Ping) ParseFrom

func (p *Ping) ParseFrom(r encoding.Reader) (err error)

func (*Ping) PktId

func (*Ping) PktId() uint32

func (*Ping) WriteTo

func (p *Ping) WriteTo(w encoding.Writer) (err error)

type Pong

type Pong struct {
	Payload uint64
}

func (*Pong) ParseFrom

func (p *Pong) ParseFrom(r encoding.Reader) (err error)

func (*Pong) PktId

func (*Pong) PktId() uint32

func (*Pong) WriteTo

func (p *Pong) WriteTo(w encoding.Writer) (err error)