raw

Documentation

Overview

Package raw provides the raw encoding for YARPC.

To make outbound requests,

client := raw.New(channel)
resBody, resMeta, err := client.Call(
	yarpc.NewReqMeta(ctx).Procedure("submit"),
	[]byte{1, 2, 3},
)

Use the Procedure function to build registrants to register against a Registry.

func Submit(reqMeta yarpc.ReqMeta, reqBody []byte) ([]byte, yarpc.ResMeta, error) {
	// ...
}

dispatcher.Register(raw.Procedure("submit", Submit))

Similarly, use the OnewayProcedure function to build registrants to register against a Registry.

func RunTask(reqMeta yarpc.ReqMeta, reqBody []byte) error {
	// ...
}

dispatcher.Register(raw.OnewayProcedure("RunTask", RunTask))

Index

• Constants
• func OnewayProcedure(name string, handler OnewayHandler) []transport.Registrant
• func Procedure(name string, handler UnaryHandler) []transport.Registrant
• func Register(r transport.Registrar, rs []transport.Registrant)
• type Client
  • func New(c transport.Channel) Client
• type OnewayHandler
• type UnaryHandler

Constants

const Encoding transport.Encoding = "raw"

Encoding is the name of this encoding.

Functions

func OnewayProcedure

func OnewayProcedure(name string, handler OnewayHandler) []transport.Registrant

OnewayProcedure builds a Registrant from the given raw handler

func Procedure

func Procedure(name string, handler UnaryHandler) []transport.Registrant

Procedure builds a Registrant from the given raw handler.

func Register

func Register(r transport.Registrar, rs []transport.Registrant)

Register calls the Registrar's Register method.

This function exists for backwards compatibility only. It will be removed in a future version.

Deprecated: Use the Registrar's Register method directly.

Types

type Client

type Client interface {
	// Call performs a unary outbound Raw request.
	Call(ctx context.Context, reqMeta yarpc.CallReqMeta, body []byte) ([]byte, yarpc.CallResMeta, error)
	// CallOneway performs a oneway outbound Raw request.
	CallOneway(ctx context.Context, reqMeta yarpc.CallReqMeta, body []byte) (transport.Ack, error)
}

Client makes Raw requests to a single service.

func New

func New(c transport.Channel) Client

New builds a new Raw client.

type OnewayHandler

type OnewayHandler func(context.Context, yarpc.ReqMeta, []byte) error

OnewayHandler implements a single, onweway procedure

type UnaryHandler

type UnaryHandler func(context.Context, yarpc.ReqMeta, []byte) ([]byte, yarpc.ResMeta, error)

UnaryHandler implements a single, unary procedure.