Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

peer

package

Go to main page

Versions in this module

v0

v0.1.0

Aug 4, 2026

v0.0.3

Jul 27, 2026

v0.0.2

Jul 27, 2026

Changes in this version

type Addr

+ IP string

+ Port int

+ func AddrFromNet(roomID, peerID string, address net.Addr) Addr

type MessageType

+ const MessageTypeDisconnect

+ const MessageTypeICEAnswer

+ const MessageTypeICEOffer

+ const MessageTypeTransportSelect

type Payload

+ ICECandidates []string

+ ICEPassword string

+ ICEUsername string

+ Transport string

+ Transports []string

v0.0.1

Jul 22, 2026

Changes in this version

+ const DefaultReceiveBufferSize

+ const ENCRYPT_GLOBALLY

+ const ENCRYPT_PARTIALY

+ const HandshakeKeySize

+ const HandshakeNonceSize

+ const INDEX_ENCRYPT_FLAG

+ const INDEX_HEADER

+ const INDEX_PACKET_LENGTH

+ const INDEX_PAYLOAD

+ const MaxClientIDLength

+ const MinPreSharedKeySize

+ var ErrReceiveBufferFull = errors.New("receive buffer limit exceeded")

+ var ErrUnknownClient = errors.New("unknown client")

+ func DeriveSessionKey(masterKey, sharedSecret, salt []byte, roomID, clientID, serverID string, ...) ([]byte, error)

+ func ICECandidateSize(candidate *webrtc.ICECandidateInit) int

+ func ServerIDFromPublicKey(publicKey ed25519.PublicKey) (string, error)

+ func SignServerHello(privateKey ed25519.PrivateKey, roomID, clientID, serverID string, ...) ([]byte, error)

+ func ValidateClientCredentials(clientID string, key []byte) error

+ func ValidateClientID(clientID string) error

+ func VerifyServerHello(publicKey ed25519.PublicKey, roomID, clientID, serverID string, ...) bool

+ type Addr struct

+ PeerID string

+ RoomID string

+ func (Addr) Network() string

+ func (a Addr) String() string

+ type ByteBudget struct

+ func NewByteBudget(limit int64) *ByteBudget

+ func (b *ByteBudget) Release(n int)

+ func (b *ByteBudget) Reserve(n int) bool

+ func (b *ByteBudget) Used() int64

+ type CallbackPool struct

+ func NewCallbackPool(workers, queueSize int) *CallbackPool

+ func (p *CallbackPool) Close()

+ func (p *CallbackPool) Submit(callback func()) bool

+ func (p *CallbackPool) SubmitWithCancel(callback, cancel func()) bool

+ type Codec struct

+ func NewCodec(encryptionType string, secret, additionalData []byte, useCompress bool) (*Codec, error)

+ func (e *Codec) DecodeMessage(data []byte) (*Message, error)

+ func (e *Codec) DecodeMessageHeader(data []byte) (*Header, error)

+ func (e *Codec) DecodeWithDecryption(data []byte) ([]byte, error)

+ func (e *Codec) DecodeWithDecryptionLimit(data []byte, maxDecodedSize int) ([]byte, error)

+ func (e *Codec) EncodeMessage(m *Message) ([]byte, error)

+ func (e *Codec) EncodeWithEncryption(data []byte) ([]byte, error)

+ func (e *Codec) GetSecret() (typ string, secret []byte)

+ func (e *Codec) UpdateSecret(encryptionType string, secret []byte) error

+ type Header struct

+ Metadata map[string]any

+ Sequence uint64

+ SourceId string

+ TargetId string

+ Type MessageType

+ func (msg *Header) Marshal() []byte

+ func (msg *Header) Unmarshal(data []byte) error

+ type KeyProvider interface

+ Key func(clientID string) ([]byte, error)

+ type KeyProviderFunc func(clientID string) ([]byte, error)

+ func (f KeyProviderFunc) Key(clientID string) ([]byte, error)

+ type Message struct

+ Encrypt bool

+ Header *Header

+ Payload *Payload

+ type MessageType string

+ const MessageTypeAnswer

+ const MessageTypeClientHello

+ const MessageTypeICE

+ const MessageTypeOffer

+ const MessageTypeServerHello

+ type Payload struct

+ ClientEphemeralKey []byte

+ ClientNonce []byte

+ Data any

+ HandshakeClientID string

+ HandshakeRoomID string

+ ICE *webrtc.ICECandidateInit

+ SDP *webrtc.SessionDescription

+ ServerEphemeralKey []byte

+ ServerNonce []byte

+ SessionSalt []byte

+ Signature []byte

+ Timestamp []byte

+ func (msg *Payload) Marshal() []byte

+ func (msg *Payload) Unmarshal(data []byte) error

+ type PreSharedKey struct

+ ClientID string

+ Key []byte

+ ServerPublicKey ed25519.PublicKey

+ func (p PreSharedKey) Validate() error

+ type RecvBuffer struct

+ func NewRecvBuffer() *RecvBuffer

+ func NewRecvBufferWithLimit(limit int, budget *ByteBudget) *RecvBuffer

+ func (rb *RecvBuffer) Close()

+ func (rb *RecvBuffer) Read(p []byte) (int, error)

+ func (rb *RecvBuffer) SetDeadline(deadline time.Time)

+ func (rb *RecvBuffer) Write(data []byte) error

+ type ReplayWindow struct

+ func (w *ReplayWindow) Accept(sequence uint64) bool

+ func (w *ReplayWindow) Reset()

+ type StaticKeyring map[string][]byte

+ func (k StaticKeyring) Key(clientID string) ([]byte, error)