Categorymosn.io/api
modulepackage
1.6.0
Repository: https://github.com/mosn/api.git
Documentation: pkg.go.dev

# README

api

This repository defines some MOSN interfaces which can be implemented by others.

install

go get mosn.io/api

# Packages

No description provided by the author

# Functions

CreateListenerFilterChainFactory creates a ListenerFilterChainFactory according to filterType.
CreateNetworkFilterChainFactory creates a NetworkFilterChainFactory according to filterType.
CreateStreamFilterChainFactory creates a StreamFilterChainFactory according to filterType.
HandleXDSConfig converts pb Any to map according to the filterType.
RegisterListener registers the filterType as ListenerFilterFactoryCreator.
RegisterNetwork registers the filterType as NetworkFilterFactoryCreator.
RegisterStream registers the filterType as StreamFilterFactoryCreator.
RegisterXDSConfigHandler registers the filterType as XDSConfigHandler.

# Constants

No description provided by the author
No description provided by the author
only arguments.
No description provided by the author
No description provided by the author
status codes.
Connection statuses.
Connection statuses.
ConnectionEvent types.
ConnectionEvent types.
ConnectionEvent types.
Connection statuses.
FilterStatus types.
protocol resource name.
inject delay.
status codes.
downstream terminated.
Path match patterns.
The host is currently failing active health checks.
The host is currently considered an outlier and has been ejected.
inject fault.
FlushWrite means write buffer to underlying io then close connection.
protocol resource name.
status codes.
status codes.
ConnectionEvent types.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NoFlush means close connection without flushing buffer.
status codes.
no healthy upstream found.
Path match patterns.
RetryCheckStatus types.
no route found.
ConnectionEvent types.
ConnectionEvent types.
ConnectionEvent types.
ConnectionEvent types.
ConnectionEvent types.
ConnectionEvent types.
only path not contains args.
status codes.
No description provided by the author
Path match patterns.
rate limited.
Path match patterns.
ConnectionEvent types.
payload limit.
No description provided by the author
No description provided by the author
No description provided by the author
RetryCheckStatus types.
status codes.
Path match patterns.
protocol resource name.
RetryCheckStatus types.
FilterStatus types.
Continue filter chain iteration.
StreamFilterStatus types.
StreamFilterStatus types.
Do not iterate to next iterator.
terminate request.
status codes.
No description provided by the author
status codes.
status codes.
connect upstream failure.
upstream terminate connection.
local reset.
upstream's connection overflow.
status codes.
upstream reset.
Upstream Request timeout.
full uri contains path + args.
Key value match patterns.
Key value match patterns.
Path match patterns.

# Variables

Error def.
Error def.
Error def.
Error def.
Error def.
Error def.
Error def.
Error def.

# Structs

DurationConfig ia a wrapper for time.Duration, so time config can be written in '300ms' or '1h' format.

# Interfaces

AccessLog is a log object that used to log the access info.
Connection interface.
ConnectionEventListener is a network level callbacks that happen on a connection.
Decoder is a decoder interface to extend various of protocols.
DirectResponseRule contains direct response info.
No description provided by the author
Encoder is a encoder interface to extend various of protocols.
FactoryInitializer represents a filter Factory needs to be inited before called.
FilterManager is a groups of filters.
GoAwayer provides the ability to construct proper GoAway command for xprotocol, It's better to NOT implement this interface instead of return nil when the protocol doesn't have goaway.
GoAwayPredicate provides the ability to judge if current is a goaway frmae, which indicates that current connection should be no longer used and turn into the draining state.
No description provided by the author
HeaderMap is a interface to provide operation facade with user-value headers.
HeartbeatBuilder provides the ability to construct proper heartbeat command for xprotocol sub-protocols.
HeartbeatPredicate provides the ability to judge if current frame is a heartbeat, which is usually used to make connection keepalive.
Hijacker provides the ability to construct proper response command for xprotocol sub-protocols.
HostInfo defines a host's basic information.
HTTPMapping maps the contents of protocols to HTTP standard.
No description provided by the author
No description provided by the author
No description provided by the author
ListenerFilterChainFactory adds filter into ListenerFilterChainFactoryCallbacks.
ListenerFilterChainFactoryCallbacks is a wrapper of FilterManager that called in NetworkFilterChainFactory.
No description provided by the author
No description provided by the author
No description provided by the author
Metrics is a wrapper interface for go-metrics support Counter, Gauge, Histogram, EWMA.
MetricsSink flush metrics to backend storage.
No description provided by the author
Multiplexing provides the ability to distinguish multi-requests in single-connection by recognize 'request-id' semantics.
NetworkFilterChainFactory adds filter into NetWorkFilterChainFactoryCallbacks.
NetWorkFilterChainFactoryCallbacks is a wrapper of FilterManager that called in NetworkFilterChainFactory.
No description provided by the author
Policy defines a group of route policy.
Protocol need to provides ability to convert mode-to-binary and vice-versa.
ProtocolEngine is a protocols' facade used by Stream, it provides auto protocol detection by the ProtocolMatch func.
ReadFilter is a connection binary read filter, registered by FilterManager.AddReadFilter.
ReadFilterCallbacks is called by read filter to talk to connection.
RedirectRule contains redirect info.
RequestInfo has information for a request, include the basic information, the request's downstream information, ,the request's upstream information and the router information.
RetryPolicy is a type of Policy.
No description provided by the author
Route is a route instance.
No description provided by the author
RouteRule defines parameters for a route.
ServiceAware provides the ability to get the most common info for rpc invocation: service name and method name.
ShadowPolicy is a type of Policy.
No description provided by the author
No description provided by the author
StreamFilterChainFactory adds filter into callbacks.
StreamFilterChainFactoryCallbacks is called in StreamFilterChainFactory.
StreamFilterHandler is called by stream filter to interact with underlying stream.
StreamReceiverFilter is a StreamFilterBase wrapper.
StreamReceiverFilterHandler add additional callbacks that allow a decoding filter to restart decoding if they decide to hold data.
StreamSenderFilter is a stream sender filter.
StreamSenderFilterHandler is a StreamFilterHandler wrapper.
No description provided by the author
VirtualHost definition.
WriteFilter is a connection binary write filter, only called by conn accept loop.
XFrame represents the minimal programmable object of the protocol.
XProtocol provides extra ability(Heartbeater, Hijacker) to interacts with the proxy framework based on the Protocol interface.
No description provided by the author
XRespFrame expose response status code based on the XFrame.

# Type aliases

ConnectionCloseType represent connection close type.
ConnectionEvent type.
Connection status.
No description provided by the author
FilterStatus type.
HealthFlag type.
KeyValueMatchType defines the header or query param match pattern.
ListenerFilterFactoryCreator creates a ListenerFilterChainFactory according to config.
No description provided by the author
Metadata field can be used to provide additional information about the route.
NetworkFilterFactoryCreator creates a NetworkFilterChainFactory according to config.
PathMatchType defines the path match pattern.
PoolMode is whether PingPong or multiplex.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ResponseFlag type.
RetryCheckStatus type.
No description provided by the author
StreamFilterFactoryCreator creates a StreamFilterChainFactory according to config.
No description provided by the author
StreamType distinguish the stream flow type.
factory.
XDSConfigHandler converts a map according to any.Any.