remotecli

Documentation

Overview

Package remotecli for remote client

Index

• type Client
  • func NewClient(ctx context.Context, ri rpcinfo.RPCInfo, handler remote.TransHandler, ...) (Client, error)
• type ConnReleaser
• type ConnWrapper
  • func NewConnWrapper(connPool remote.ConnPool) *ConnWrapper
  • func (cm *ConnWrapper) GetConn(ctx context.Context, d remote.Dialer, ri rpcinfo.RPCInfo) (net.Conn, error)
  • func (cm *ConnWrapper) ReleaseConn(err error, ri rpcinfo.RPCInfo)
• type StreamConnManager
  • func NewStream(ctx context.Context, ri rpcinfo.RPCInfo, handler remote.ClientTransHandler, ...) (any, *StreamConnManager, error)
  • func NewStreamConnManager(cr ConnReleaser) *StreamConnManager
  • func (scm *StreamConnManager) ReleaseConn(err error, ri rpcinfo.RPCInfo)

Types

type Client

type Client interface {
	// RPCInfo as param just avoid to get it from ctx
	Send(ctx context.Context, ri rpcinfo.RPCInfo, req remote.Message) (err error)
	Recv(ctx context.Context, ri rpcinfo.RPCInfo, resp remote.Message) (err error)
	Recycle()
}

Client implementation may be different between mux and non-mux clients.

func NewClient

func NewClient(ctx context.Context, ri rpcinfo.RPCInfo, handler remote.TransHandler, opt *remote.ClientOption) (Client, error)

NewClient creates a new Client using the given params.

type ConnReleaser

type ConnReleaser interface {
	ReleaseConn(err error, ri rpcinfo.RPCInfo)
}

ConnReleaser helps to release the raw connection.

type ConnWrapper

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

ConnWrapper wraps a connection.

func NewConnWrapper

func NewConnWrapper(connPool remote.ConnPool) *ConnWrapper

NewConnWrapper returns a new ConnWrapper using the given connPool and logger.

func (*ConnWrapper) GetConn

func (cm *ConnWrapper) GetConn(ctx context.Context, d remote.Dialer, ri rpcinfo.RPCInfo) (net.Conn, error)

GetConn returns a connection using the given Dialer and RPCInfo.

func (*ConnWrapper) ReleaseConn

func (cm *ConnWrapper) ReleaseConn(err error, ri rpcinfo.RPCInfo)

ReleaseConn should notice that ri may nil when oneway TODO duplicate release may cause problem?

type StreamConnManager

type StreamConnManager struct {
	ConnReleaser
}

StreamConnManager manages the underlying connection of the stream

func NewStream

func NewStream(ctx context.Context, ri rpcinfo.RPCInfo, handler remote.ClientTransHandler, opt *remote.ClientOption) (any, *StreamConnManager, error)

NewStream create a client side stream

func NewStreamConnManager

func NewStreamConnManager(cr ConnReleaser) *StreamConnManager

NewStreamConnManager returns a new StreamConnManager

func (*StreamConnManager) ReleaseConn

func (scm *StreamConnManager) ReleaseConn(err error, ri rpcinfo.RPCInfo)

ReleaseConn releases the raw connection of the stream