protocol

package

v0.13.3-alpha.2 Latest Latest Go to latest Published: Feb 10, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package protocol provides defines APIs of protocol.

This section is empty.

This section is empty.

func Register(p Protocol)

Register registers the protocol to the registry.

func Unregister(name string)

Unregister unregisters the protocol from the registry.

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

AssertionBuilder builds the assertion for the result of Invoke.

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 interface {
	Name() string
	UnmarshalRequest([]byte) (Invoker, error)
	UnmarshalExpect([]byte) (AssertionBuilder, error)
}

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

func Get(name string) Protocol

Get returns the protocol registered with the given name.