protocol

Documentation

Overview

Package protocol provides defines APIs of protocol.

Index

• func Register(p Protocol)
• func Unregister(name string)
• type AssertionBuilder
• type Invoker
• type Protocol
  • func Get(name string) Protocol
• type QueryOptionsProvider

Functions

func Register

func Register(p Protocol)

Register registers the protocol to the registry.

func Unregister

func Unregister(name string)

Unregister unregisters the protocol from the registry.

Types

type AssertionBuilder

type AssertionBuilder interface {
	Build(*context.Context) (assert.Assertion, error)
}

AssertionBuilder builds the assertion for the result of Invoke.

type Invoker

type Invoker interface {
	Invoke(*context.Context) (*context.Context, interface{}, error)
}

Invoker is the interface that sends the request and returns response sent from the server.

type Protocol

type Protocol interface {
	Name() string
	UnmarshalRequest([]byte) (Invoker, error)
	UnmarshalExpect([]byte) (AssertionBuilder, error)
}

Protocol is the interface that creates Invoker and AssertionBuilder from YAML.

func Get

func Get(name string) Protocol

Get returns the protocol registered with the given name.

type QueryOptionsProvider

type QueryOptionsProvider interface {
	QueryOptions() []query.Option
}

QueryOptionsProvider is the interface that provides custom querying options.