protocol

Documentation

Index

• func ParseIDsToStrings(pids []ID) []string
• type DataPackage
  • func (d *DataPackage) Marshal(buf []byte) ([]byte, error)
  • func (d *DataPackage) Size() (s uint64)
  • func (d *DataPackage) Unmarshal(buf []byte) (uint64, error)
• type ID
  • func ParseStringsToIDs(strs []string) []ID
• type Package
  • func NewPackage(id ID, payload []byte) *Package
  • func (m *Package) FromBytes(data []byte) error
  • func (m *Package) Payload() []byte
  • func (m *Package) ProtocolID() ID
  • func (m *Package) ToBytes(enableCompress bool) ([]byte, error)

Functions

func ParseIDsToStrings

func ParseIDsToStrings(pids []ID) []string

ParseIDsToStrings parses ID slice to string slice.

Types

type DataPackage

type DataPackage struct {
	Protocol string
	Payload  []byte
	Compress bool
}

func (*DataPackage) Marshal

func (d *DataPackage) Marshal(buf []byte) ([]byte, error)

func (*DataPackage) Size

func (d *DataPackage) Size() (s uint64)

func (*DataPackage) Unmarshal

func (d *DataPackage) Unmarshal(buf []byte) (uint64, error)

type ID

type ID string

ID is an identifier used to mark the module which the net msg belong to.

const (
	// TestingPID is a protocol id for testing.
	TestingPID ID = "/_testing"
)

func ParseStringsToIDs

func ParseStringsToIDs(strs []string) []ID

ParseStringsToIDs parses string slice to ID slice.

type Package

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

Package is a container for net message.

func NewPackage

func NewPackage(id ID, payload []byte) *Package

NewPackage create a Package contains message payload with protocol.

func (*Package) FromBytes

func (m *Package) FromBytes(data []byte) error

FromBytes parse bytes received from receive stream into Package.

func (*Package) Payload

func (m *Package) Payload() []byte

Payload return the message payload bytes.

func (*Package) ProtocolID

func (m *Package) ProtocolID() ID

ProtocolID return the protocol id that the message marked.

func (*Package) ToBytes

func (m *Package) ToBytes(enableCompress bool) ([]byte, error)

ToBytes parse Package to bytes for sending on stream finally.