gosr

README

gosr

a simple frame of send and receive on conn for golang

Documentation

Index

• type Call
• type Client
  • func NewClientWithCodec(codec ClientCodec) Client
• type ClientCodec
• type Error
  • func Errof(format string, args ...interface{}) Error
• type Request
• type Response

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.
	Context       interface{}
	// 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
	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 Error

type Error error

Error ...

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

func Errof

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

Errof ...

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 ...