README
¶
package drpchttp
import "storj.io/drpc/drpchttp"
Package drpchttp implements a net/http handler for unitary RPCs.
Usage
func Context
func Context(req *http.Request) (context.Context, error)
Context returns the context.Context from the http.Request with any metadata sent using the X-Drpc-Metadata header set as values.
func JSONMarshal
func JSONMarshal(msg drpc.Message, enc drpc.Encoding) ([]byte, error)
JSONMarshal looks for a JSONMarshal method on the encoding and calls that if it exists. Otherwise, it does a normal message marshal before doing a JSON marshal.
func JSONUnmarshal
func JSONUnmarshal(buf []byte, msg drpc.Message, enc drpc.Encoding) error
JSONUnmarshal looks for a JSONUnmarshal method on the encoding and calls that if it exists. Otherwise, it JSON unmarshals the buf before doing a normal message unmarshal.
func New
func New(handler drpc.Handler) http.Handler
New returns a net/http.Handler that dispatches to the passed in drpc.Handler.
The returned value handles unitary RPCs over an http request. The RPCs are
hosted at a path based on their name, like /service.Server/Method and accept
the request message in JSON or protobuf, depending on if the requested
Content-Type is equal to "application/json" or "application/protobuf",
respectively. If the response was a success, the HTTP status code will be 200
OK, and the body contains the message encoded the same way as the request. If
there was an error, the HTTP status code will not be 200 OK, the response body
is always JSON, and will look something like
{
"code": "...",
"msg": "..."
}
where msg is a textual description of the error, and code is a short string that describes the kind of error that happened, if possible. If nothing could be detected, then the string "unknown" is used for the code.
Metadata can be attached by adding the "X-Drpc-Metadata" header to the request possibly multiple times. The format is
X-Drpc-Metadata: percentEncode(key)=percentEncode(value)
where percentEncode is the encoding used for query strings. Only the '%' and '=' characters are necessary to be escaped.
Documentation
¶
Overview ¶
Package drpchttp implements a net/http handler for unitary RPCs.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Context ¶
Context returns the context.Context from the http.Request with any metadata sent using the X-Drpc-Metadata header set as values.
func JSONMarshal ¶
JSONMarshal looks for a JSONMarshal method on the encoding and calls that if it exists. Otherwise, it does a normal message marshal before doing a JSON marshal.
func JSONUnmarshal ¶
JSONUnmarshal looks for a JSONUnmarshal method on the encoding and calls that if it exists. Otherwise, it JSON unmarshals the buf before doing a normal message unmarshal.
func New ¶
New returns a net/http.Handler that dispatches to the passed in drpc.Handler.
The returned value handles unitary RPCs over an http request. The RPCs are hosted at a path based on their name, like `/service.Server/Method` and accept the request message in JSON or protobuf, depending on if the requested Content-Type is equal to "application/json" or "application/protobuf", respectively. If the response was a success, the HTTP status code will be 200 OK, and the body contains the message encoded the same way as the request. If there was an error, the HTTP status code will not be 200 OK, the response body is always JSON, and will look something like
{
"code": "...",
"msg": "..."
}
where msg is a textual description of the error, and code is a short string that describes the kind of error that happened, if possible. If nothing could be detected, then the string "unknown" is used for the code.
Metadata can be attached by adding the "X-Drpc-Metadata" header to the request possibly multiple times. The format is
X-Drpc-Metadata: percentEncode(key)=percentEncode(value)
where percentEncode is the encoding used for query strings. Only the '%' and '=' characters are necessary to be escaped.
Types ¶
This section is empty.
Source Files