packetbuffer

Documentation

Overview

Package packetbuffer implements functions for the manipulation of byte slices.

Index

• type PacketBuffer
  • func New(conn net.PacketConn, size int) *PacketBuffer
  • func (pb *PacketBuffer) Close()
  • func (pb *PacketBuffer) CurrentPacketAddr() net.Addr
  • func (pb *PacketBuffer) Next() error
  • func (pb *PacketBuffer) Read(p []byte) (n int, err error)

Types

type PacketBuffer

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

PacketBuffer encapsulates a packet connection and implements the io.Reader interface.

func New

func New(conn net.PacketConn, size int) *PacketBuffer

New creates a packet buffer with specific packet connection and size.

func (*PacketBuffer) Close

func (pb *PacketBuffer) Close()

Close closes this buffer and releases resource.

func (*PacketBuffer) CurrentPacketAddr

func (pb *PacketBuffer) CurrentPacketAddr() net.Addr

CurrentPacketAddr returns current packet's remote address.

func (*PacketBuffer) Next

func (pb *PacketBuffer) Next() error

Next is used to distinguish continuous logic reads. It indicates that the reading on current packet has finished. If there remains data unconsumed, Next returns an error and discards the remaining data.

func (*PacketBuffer) Read

func (pb *PacketBuffer) Read(p []byte) (n int, err error)

Read reads data from the packet. Continuous reads cannot cross between multiple packet only if Close is called.