model

Documentation

Index

• type PeerMessage
  • func ParsePeerMessage(message []byte) (*PeerMessage, error)
  • func (m *PeerMessage) Serialize() []byte

Types

type PeerMessage

type PeerMessage struct {
	// ID **must** only contain alphanumeric characters separated by period.
	ID string // A unique Message ID (primarily used for acknowledgments)

	// Context **must** only contain alphanumeric characters separated by period.
	Context string // A unique context identifier i.e. im.cwtch.chat

	// Data can contain anything
	Data []byte // A data packet.
}

PeerMessage is an encapsulation that can be used by higher level applications

func ParsePeerMessage

func ParsePeerMessage(message []byte) (*PeerMessage, error)

ParsePeerMessage returns either a deserialized PeerMessage or an error if it is malformed

func (*PeerMessage) Serialize

func (m *PeerMessage) Serialize() []byte

Serialize constructs an efficient serialized representation Format: [ID String] | [Context String] | Binary Data