package
1.7.1
Repository: https://github.com/vine-io/vine.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author

# Functions

Address to bind to - host:port.
Advertise the address to advertise for discovery - host:port.
Broker to use for pub/sub.
Codec to use to encode/decode requests for a given content type.
Context specifies a context for the service.
DefaultOptions returns config options for the default service.
DisableAutoAck will disable auto acking of messages after they have been handled.
EndpointMetadata is a Handler option that allows metadata to be added to individual endpoints.
Handle registers a handler interface with the default server to handle inbound requests.
Id Unique server id.
Init initialises the default server with options passed in.
InternalHandler options specifies that a handler is not advertised to the discovery system.
InternalSubscriber options specifies that a subscriber is not advertised to the discovery system.
Metadata associated with the server.
Name the name of server.
NewHandler creates a new handler interface using the default server Handlers are required to be a public object with public endpoint.
No description provided by the author
NewSubscriber creates a new subscriber interface with the given topic and handler using the default server.
No description provided by the author
RegisterCheck run func before registry service.
RegisterInterval register the service with at interval.
RegisterTTL register the service with a TTL.
Registry used for discovery.
Run starts the default server and waits for a kill signal before existing.
Start starts the default server.
Stop stops the default server.
String returns name of Server implementation.
Subscribe registers a subscriber interface with the default server which subscribes to specified topic with the broker.
SubscriberContext set context options to allow broker SubscriberOption passed.
SubscriberQueue Shared queue name distributed messages across subscribers.
Version of the service.
Wait tells the server to wait for requests to finish before exiting If `wg` is nil, server only wait for completion of rpc handler.
WithRouter sets the request router.
WrapHandler adds a handler Wrapper to a list of options passed into the server.
WrapSubscriber adds a subscriber Wrapper to a list of options passed into the server.

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

Handler interface represents a request handler.
Message is an async message interface.
Request is a synchronous request interface.
Response is the response write for unencoded messages.
Router handle serving messages.
Server is a simple vine server abstraction.
Stream represents a stream established with a client.
Subscriber interface represents a subscription to a given topic using a specific subscriber function or object with endpoints.

# Type aliases

HandlerFunc represents a single method of a handler.
No description provided by the author
HandlerWrapper wraps the HandlerFunc and returns the equivalent.
No description provided by the author
StreamWrapper wraps a Stream interface and returns the equivalent.
SubscriberFunc represents a single method of a subscriber.
No description provided by the author
SubscriberWrapper wraps the SubscriberFunc and returns the equivalent.