node

Documentation

Index

• Variables
• type Channel
• type DiscoverOptions
• type LastMessage
  • func NewLastMessage() *LastMessage
  • func (m *LastMessage) Get() *domain.Message
  • func (m *LastMessage) ListenUpdates()
• type Node
  • func New(clipboard clipboard.Manager, peers *Storage, localClipboard Channel, ...) *Node
  • func (n *Node) Broadcast(msg *domain.Message, ignore domain.UniqueID)
  • func (n *Node) ConnectTo(addr string) error
  • func (n *Node) MonitorBuffer()
  • func (n *Node) Notify(message string, v ...any)
  • func (n *Node) Start() error
• type Option
  • func WithBitSize(size int) Option
  • func WithClipboardScanDelay(delay time.Duration) Option
  • func WithDiscovering(opt DiscoverOptions) Option
  • func WithKeepAlive(duration time.Duration) Option
  • func WithNotifier(notifier notification.Notifier) Option
  • func WithPublicPort(port int) Option
  • func WithWriteTimeout(timeout time.Duration) Option
• type Options
  • func NewOptions(opts ...Option) *Options
• type Peer
  • func AcquirePeer(opts ...PeerOption) *Peer
  • func (p *Peer) Addr() netip.AddrPort
  • func (p *Peer) Close() error
  • func (p *Peer) Conn() net.Conn
  • func (p *Peer) MetaData() domain.MetaData
  • func (p *Peer) Receive(last *LastMessage)
  • func (p *Peer) Signer() crypto.Signer
  • func (p *Peer) String() string
• type PeerOption
  • func WithCipher(cipher *encrypter.Cipher) PeerOption
  • func WithConn(conn net.Conn) PeerOption
  • func WithLocalClipboard(updates Channel) PeerOption
  • func WithMetaData(meta domain.MetaData) PeerOption
• type Storage

Variables

var (
	ErrAlreadyConnected = errors.New("already connected")
)

Types

type Channel

type Channel chan *domain.Message

Channel is an interface for managing clipboard data.

type DiscoverOptions

type DiscoverOptions struct {
	Enable   bool
	Delay    time.Duration
	MaxPeers int
}

type LastMessage

type LastMessage struct {
	*domain.Message

	Update chan *domain.Message
	// contains filtered or unexported fields
}

LastMessage which is stored in Node and serves to identify duplicate messages

func NewLastMessage

func NewLastMessage() *LastMessage

func (*LastMessage) Get

func (m *LastMessage) Get() *domain.Message

func (*LastMessage) ListenUpdates

func (m *LastMessage) ListenUpdates()

ListenUpdates updates the lastMessage with the latest message received

type Node

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

func New

func New(
	clipboard clipboard.Manager,
	peers *Storage,
	localClipboard Channel,
	opts ...Option,
) *Node

New creates a new instance of Node with the specified settings.

func (*Node) Broadcast

func (n *Node) Broadcast(msg *domain.Message, ignore domain.UniqueID)

Broadcast sends a message to all connected nodes except those specified in the 'ignore' list. It first checks if the message is a duplicate of the last sent message by comparing their IDs and hashes. If the message is a duplicate, it is not sent. For each connection in the storage, it writes the message to the connection's writer. The method logs the sent messages and their hashes for debugging purposes. The 'msg' parameter is the message to be broadcast. The 'ignore' parameter is a variadic list of AddrPort to exclude from the broadcast.

func (*Node) ConnectTo

func (n *Node) ConnectTo(addr string) error

ConnectTo establishes a TCP connection to a remote clipboard at the specified address. It adds the connection to the node's storage and starts handling the connection using 'handleConnection'. The 'addr' parameter should be in the format "host:port" to specify the remote clipboard's address. If the connection is successfully established, it returns nil; otherwise, it returns an error.

func (*Node) MonitorBuffer

func (n *Node) MonitorBuffer()

MonitorBuffer starts monitoring the clipboard and subsequently sending data to other nodes

func (*Node) Notify

func (n *Node) Notify(message string, v ...any)

func (*Node) Start

func (n *Node) Start() error

Start starts the node by listening for incoming connections on the specified public port. It also starts a clipboard monitor to periodically scan and update the local clipboard. When a new connection is accepted, it invokes the 'handleConnection' method to handle the connection. The 'scanDelay' parameter determines the interval at which the clipboard is scanned and updated. The method returns an error if it fails to start listening.

type Option

type Option func(*Options)

Option defines the method to configure Options

func WithBitSize

func WithBitSize(size int) Option

func WithClipboardScanDelay

func WithClipboardScanDelay(delay time.Duration) Option

func WithDiscovering

func WithDiscovering(opt DiscoverOptions) Option

func WithKeepAlive

func WithKeepAlive(duration time.Duration) Option

func WithNotifier

func WithNotifier(notifier notification.Notifier) Option

func WithPublicPort

func WithPublicPort(port int) Option

func WithWriteTimeout

func WithWriteTimeout(timeout time.Duration) Option

type Options

type Options struct {
	PublicPort         int
	BitSize            int
	KeepAlive          time.Duration
	ClipboardScanDelay time.Duration
	WriteTimeout       time.Duration
	Notifier           notification.Notifier
	Discovering        DiscoverOptions
}

func NewOptions

func NewOptions(opts ...Option) *Options

NewOptions creates Options with provided options

type Peer

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

func AcquirePeer

func AcquirePeer(opts ...PeerOption) *Peer

func (*Peer) Addr

func (p *Peer) Addr() netip.AddrPort

func (*Peer) Close

func (p *Peer) Close() error

func (*Peer) Conn

func (p *Peer) Conn() net.Conn

func (*Peer) MetaData

func (p *Peer) MetaData() domain.MetaData

func (*Peer) Receive

func (p *Peer) Receive(last *LastMessage)

func (*Peer) Signer

func (p *Peer) Signer() crypto.Signer

func (*Peer) String

func (p *Peer) String() string

type PeerOption

type PeerOption func(*Peer)

func WithCipher

func WithCipher(cipher *encrypter.Cipher) PeerOption

func WithConn

func WithConn(conn net.Conn) PeerOption

func WithLocalClipboard

func WithLocalClipboard(updates Channel) PeerOption

func WithMetaData

func WithMetaData(meta domain.MetaData) PeerOption

type Storage

type Storage = storage.SyncMap[domain.UniqueID, *Peer]