resonance

README

resonance

Communication library using proton messages

Documentation

Index

• func RunClient(ctx context.Context, addr string, config Config, ...) error
• func RunServer(ctx context.Context, ls net.Listener, config Config, ...) error
• type Config
• type Connection
  • func NewConnection(peer Peer, config Config) *Connection
  • func (c *Connection) BufferReads()
  • func (c *Connection) BufferWrites()
  • func (c *Connection) BytesSent() uint64
  • func (c *Connection) Close()
  • func (c *Connection) ReceiveBytes() ([]byte, error)
  • func (c *Connection) ReceiveProton(m ProtonUnmarshaller) (any, error)
  • func (c *Connection) ReceiveRawBytes() ([]byte, error)
  • func (c *Connection) SendBytes(msg []byte) (retErr error)
  • func (c *Connection) SendProton(msg any, m ProtonMarshaller) (retErr error)
  • func (c *Connection) SendRawBytes(msg []byte) (retErr error)
  • func (c *Connection) SendStream(r io.Reader) (retErr error)
• type Peer
• type PeerBuffer
  • func NewPeerBuffer() PeerBuffer
  • func (b PeerBuffer) Close() error
  • func (b PeerBuffer) OtherPeer() PeerBuffer
  • func (b PeerBuffer) Read(buf []byte) (int, error)
  • func (b PeerBuffer) ReadFrom(r io.Reader) (int64, error)
  • func (b PeerBuffer) RunReader(ctx context.Context, peer Peer) error
  • func (b PeerBuffer) RunWriter(ctx context.Context, peer Peer) error
  • func (b PeerBuffer) Write(buf []byte) (int, error)
  • func (b PeerBuffer) WriteTo(w io.Writer) (int64, error)
• type ProtonMarshaller
• type ProtonUnmarshaller

Functions

func RunClient

func RunClient(
	ctx context.Context,
	addr string,
	config Config,
	handler func(ctx context.Context, c *Connection) error,
) error

RunClient runs client.

func RunServer

func RunServer(
	ctx context.Context,
	ls net.Listener,
	config Config,
	handler func(ctx context.Context, c *Connection) error,
) error

RunServer runs server.

Types

type Config

type Config struct {
	MaxMessageSize uint64
}

Config is the configuration of connection.

type Connection

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

Connection allows to communicate with the peer.

func NewConnection

func NewConnection(peer Peer, config Config) *Connection

NewConnection creates new connection.

func (*Connection) BufferReads

func (c *Connection) BufferReads()

BufferReads turns on read buffer.

func (*Connection) BufferWrites

func (c *Connection) BufferWrites()

BufferWrites turns on write buffer.

func (*Connection) BytesSent

func (c *Connection) BytesSent() uint64

BytesSent returns the number of bytes sent over the connection, excluding pings.

func (*Connection) Close

func (c *Connection) Close()

Close closes connection.

func (*Connection) ReceiveBytes

func (c *Connection) ReceiveBytes() ([]byte, error)

ReceiveBytes receives bytes.

func (*Connection) ReceiveProton

func (c *Connection) ReceiveProton(m ProtonUnmarshaller) (any, error)

ReceiveProton receives proton message from the peer.

func (*Connection) ReceiveRawBytes

func (c *Connection) ReceiveRawBytes() ([]byte, error)

ReceiveRawBytes receives bytes and returns them with together with length prefix.

func (*Connection) SendBytes

func (c *Connection) SendBytes(msg []byte) (retErr error)

SendBytes sends bytes.

func (*Connection) SendProton

func (c *Connection) SendProton(msg any, m ProtonMarshaller) (retErr error)

SendProton sends proton message to the peer.

func (*Connection) SendRawBytes

func (c *Connection) SendRawBytes(msg []byte) (retErr error)

SendRawBytes sends bytes with length prefix already included.

func (*Connection) SendStream

func (c *Connection) SendStream(r io.Reader) (retErr error)

SendStream sends stream of data taken from the reader.

type Peer

type Peer io.ReadWriteCloser

Peer represents the connected peer.

type PeerBuffer

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

PeerBuffer simulates the network connection from the peer's view.

func NewPeerBuffer

func NewPeerBuffer() PeerBuffer

NewPeerBuffer returns new peer buffer.

func (PeerBuffer) Close

func (b PeerBuffer) Close() error

Close closes the streams.

func (PeerBuffer) OtherPeer

func (b PeerBuffer) OtherPeer() PeerBuffer

OtherPeer returns the corresponding buffer for the other peer in the connection.

func (PeerBuffer) Read

func (b PeerBuffer) Read(buf []byte) (int, error)

Read reads data from the read buffer.

func (PeerBuffer) ReadFrom

func (b PeerBuffer) ReadFrom(r io.Reader) (int64, error)

ReadFrom reads data from the incoming stream.

func (PeerBuffer) RunReader

func (b PeerBuffer) RunReader(ctx context.Context, peer Peer) error

RunReader reads data from peer.

func (PeerBuffer) RunWriter

func (b PeerBuffer) RunWriter(ctx context.Context, peer Peer) error

RunWriter writes data to peer.

func (PeerBuffer) Write

func (b PeerBuffer) Write(buf []byte) (int, error)

Write writes data to the write buffer.

func (PeerBuffer) WriteTo

func (b PeerBuffer) WriteTo(w io.Writer) (int64, error)

WriteTo writes data to the outgoing stream.

type ProtonMarshaller

type ProtonMarshaller interface {
	Size(msg any) (uint64, error)
	Marshal(msg any, buf []byte) (uint64, uint64, error)
}

ProtonMarshaller is the proton's interface marshalling messages.

type ProtonUnmarshaller

type ProtonUnmarshaller interface {
	Unmarshal(id uint64, buf []byte) (any, uint64, error)
}

ProtonUnmarshaller is the proton's interface unmarshalling messages.