network

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

type Connection interface {
	io.Closer
	Status

	// LocalAddr returns the local net multi-address of the connection.
	LocalAddr() ma.Multiaddr

	// LocalNetAddr returns the local net address of the connection.
	LocalNetAddr() net.Addr

	// LocalPeerID returns the local peer ID of the connection.
	LocalPeerID() peer.ID

	// RemoteAddr returns the remote net multi-address of the connection.
	RemoteAddr() ma.Multiaddr

	// RemoteNetAddr returns the remote net address of the connection.
	RemoteNetAddr() net.Addr

	// RemotePeerID returns the remote peer ID of the connection.
	RemotePeerID() peer.ID

	// Network returns the network instance that created this connection.
	Network() Network

	// OpenSendStream tries to open a sending stream with the connection.
	OpenSendStream() (SendStream, error)

	// AcceptReceiveStream accepts a receiving stream with the connection.
	// It will block until a new receiving stream is accepted or the connection is closed.
	AcceptReceiveStream() (ReceiveStream, error)
}

type Dialer interface {
	// Dial tries to establish an outbound connection with the remote address.
	Dial(ctx context.Context, remoteAddr ma.Multiaddr) (Connection, error)
}

type Direction uint8

type Listener interface {
	io.Closer

	// Listen runs a task that creates listeners with the given addresses and waits for accepting inbound connections.
	// It returns an error if there is any issue starting the listeners.
	Listen(ctx context.Context, addresses ...ma.Multiaddr) error

	// ListenAddresses returns the list of local addresses for the listeners.
	ListenAddresses() []ma.Multiaddr
}

type Network interface {
	Dialer
	Listener
	io.Closer

	// AcceptedConnChan returns a channel for notifying about new connections.
	// Whenever a new connection is accepted or dialed, Network should write the new connection to chan.
	AcceptedConnChan() <-chan Connection

	// Disconnect closes a connection.
	Disconnect(conn Connection) error

	// Closed returns whether the network is closed.
	Closed() bool

	// LocalPeerID returns the local peer ID.
	LocalPeerID() peer.ID

	// Logger returns the logger instance.
	Logger() *rainbowlog.Logger
}

type ReceiveStream interface {
	io.Reader
	// contains filtered or unexported methods
}

type SendStream interface {
	io.Writer
	// contains filtered or unexported methods
}

type Status interface {
	Direction() Direction
	EstablishedTime() time.Time
	Extra() map[any]any
	SetClosed()
	Closed() bool
}