gosr

README

gosr

a simple frame of send and receive on conn for golang

Documentation

Index

• Variables
• func NewBlockReadWriteCloser() io.ReadWriteCloser
• func NewTestConn() (local, remote net.Conn)
• type Call
• type Client
  • func NewClientWithCodec(codec ClientCodec) Client
• type ClientCodec
• type CodecAdapter
  • func (p CodecAdapter) ReadRequestHeader(req *Request) error
  • func (p CodecAdapter) ReadResponseHeader(rsp *Response) error
• type Dual
  • func NewDualWithCodec(codec DualCodec, handlers *HandlerManager, ctx interface{}) Dual
• type DualCodec
• type DualHeader
  • func (p *DualHeader) ToRequest(request *Request)
  • func (p *DualHeader) ToResponse(response *Response)
• type Error
  • func Errof(format string, args ...interface{}) Error
• type HandlerManager
  • func NewHandlerManager() *HandlerManager
  • func (p *HandlerManager) Register(serviceMethod interface{}, rcvr interface{}) error
• type Request
• type Response
• type ResponseWriter
  • func (p *ResponseWriter) Free()
  • func (p *ResponseWriter) Reply(reply interface{}) error
• type Server
  • func NewServerWithCodec(handlerManager *HandlerManager, codec ServerCodec, ctx interface{}) Server
• type ServerCodec
• type ServerFunction
  • func (p *ServerFunction) Call()

Variables

var (
	// ErrTimeout ...
	ErrTimeout = errors.New("timeout")
)

Functions

func NewBlockReadWriteCloser

func NewBlockReadWriteCloser() io.ReadWriteCloser

NewBlockReadWriteCloser ...

func NewTestConn

func NewTestConn() (local, remote net.Conn)

NewTestConn ...

Types

type Call

type Call struct {
	ServiceMethod interface{}
	Args          interface{} // The argument to the function (*struct).
	Reply         interface{} // The reply from the function (*struct).
	Error         error       // After completion, the error status.
	Done          chan *Call  // Strobes when call is complete.
	// contains filtered or unexported fields
}

Call represents an active RPC.

type Client

type Client interface {
	Close() error
	Go(serviceMethod, args interface{}, reply interface{}, done chan *Call) *Call
	Call(serviceMethod, args interface{}, reply interface{}) error
	CallAsync(serviceMethod, args, reply interface{}, cb func(*Call))
	CallWithoutReply(serviceMethod, args interface{}) error
	Wait()
}

Client ...

func NewClientWithCodec

func NewClientWithCodec(codec ClientCodec) Client

NewClientWithCodec is like NewClient but uses the specified codec to encode requests and decode responses.

type ClientCodec

type ClientCodec interface {
	GetSeq(req *Request) (seq interface{})
	WriteRequest(req *Request, args interface{}) error
	ReadResponseHeader(*Response) error
	ReadResponseBody(resp *Response, reply interface{}) error
	Close() error
}

A ClientCodec implements writing of RPC requests and reading of RPC responses for the p side of an RPC session. The p calls WriteRequest to write a request to the connection and calls ReadResponseHeader and ReadResponseBody in pairs to read responses. The p calls Close when finished with the connection. ReadResponseBody may be called with a nil argument to force the body of the response to be read and then discarded. See NewClient's comment for information about concurrent access.

type CodecAdapter

type CodecAdapter struct {
	DualCodec
}

CodecAdapter ...

func (CodecAdapter) ReadRequestHeader

func (p CodecAdapter) ReadRequestHeader(req *Request) error

ReadRequestHeader ...

func (CodecAdapter) ReadResponseHeader

func (p CodecAdapter) ReadResponseHeader(rsp *Response) error

ReadResponseHeader ...

type Dual

type Dual interface {
	Server
	Client() Client
}

Dual ...

func NewDualWithCodec

func NewDualWithCodec(codec DualCodec, handlers *HandlerManager, ctx interface{}) Dual

NewDualWithCodec ...

type DualCodec

type DualCodec interface {
	GetSeq(*Request) (seq interface{})
	WriteRequest(*Request, interface{}) error
	WriteResponse(*Response, interface{}) error
	ReadHeader(*DualHeader) error
	ReadRequestBody(req *Request, args interface{}) error
	ReadResponseBody(resp *Response, reply interface{}) error
	Close() error
}

DualCodec ...

type DualHeader

type DualHeader struct {
	Seq           interface{}
	ServiceMethod interface{}
	Error         error
	Context       interface{}
	IsRequest     bool
}

DualHeader ...

func (*DualHeader) ToRequest

func (p *DualHeader) ToRequest(request *Request)

ToRequest ...

func (*DualHeader) ToResponse

func (p *DualHeader) ToResponse(response *Response)

ToResponse ...

type Error

type Error error

Error ...

var (
	// ErrClosed ...
	ErrClosed Error = fmt.Errorf("[gosr] closed")
)

func Errof

func Errof(format string, args ...interface{}) Error

Errof ...

type HandlerManager

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

HandlerManager ...

func NewHandlerManager

func NewHandlerManager() *HandlerManager

NewHandlerManager ...

func (*HandlerManager) Register

func (p *HandlerManager) Register(serviceMethod interface{}, rcvr interface{}) error

Register ...

type Request

type Request struct {
	Seq           interface{}
	ServiceMethod interface{}
	Context       interface{}
}

Request ...

type Response

type Response struct {
	Seq           interface{}
	ServiceMethod interface{}
	Error         error
	Context       interface{}
}

Response ...

type ResponseWriter

type ResponseWriter struct {
	*Response
	// contains filtered or unexported fields
}

ResponseWriter ...

func (*ResponseWriter) Free

func (p *ResponseWriter) Free()

Free ...

func (*ResponseWriter) Reply

func (p *ResponseWriter) Reply(reply interface{}) error

Reply ...

type Server

type Server interface {
	Serve()
	ServeRequest() error
	ReadFunction(*ServerFunction) error
	SetContext(interface{})
}

Server ...

func NewServerWithCodec

func NewServerWithCodec(handlerManager *HandlerManager, codec ServerCodec, ctx interface{}) Server

NewServerWithCodec ...

type ServerCodec

type ServerCodec interface {
	ReadRequestHeader(req *Request) error
	ReadRequestBody(req *Request, args interface{}) error
	WriteResponse(resp *Response, reply interface{}) error
}

ServerCodec ...

type ServerFunction

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

ServerFunction ...

func (*ServerFunction) Call

func (p *ServerFunction) Call()

Call ...