package
0.0.0-20200218003521-8dcdab8c7a5e
Repository: https://github.com/sisatech/goapi.git
Documentation: pkg.go.dev

# Functions

NewClient creates and connects a new GraphQL web socket client to a GraphQL web socket server.
NewCluster returns a basic implementation of the Cluster interface assembled from implementations of the various critical elements of the provided ClusterConfig.
NewSchema analyzes the provided 'graphql.Schema' and returns an implementation of the Schema interface.
No description provided by the author

# Constants

GQL message types.
GQL message types.
GQL message types.
GQL message types.
GQL message types.
GQL message types.
GQL message types.
GQL message types.
GQL message types.
GQL message types.

# Structs

Client manages a single connection to a GraphQL web socket server, which may host any number of GraphQL queries, mutations, and subscriptions concurrently.
ClientConfig aggregates adjustable settings that can be used to modify the behaviour of the GraphQL web socket client.
Cluster represents an entire cluster of Publishers working as a HA (highly-available) unit.
ClusterConfig contains fields used to customize the behaviour of a basic implementation of the Cluster interface.
GQLDataPayload is a generic structure for a response to a valid GraphQL operation.
GQLError contains an error description with information meant to be useful for a developer that needs to debug it.
GQLErrorLocation contains a reference to a location in the operation's query string related to an error that has occurred.
GQLStartPayload is the structure for a GQL_START message payload.
Message is the generalized form for a GraphQL over websocket message.
MutationConfig contains fields used by the client to perform a GraphQL mutation clientOperation.
QueryConfig contains fields used by the client to perform a GraphQL query clientOperation.
No description provided by the author
No description provided by the author
SimplePeer is the basic implementation of the Peer interface.
Subscription provides a handle for an active subscription with functions to terminate the subscription and to wait until the subscription has finished.
SubscriptionConfig contains fields used by the client to perform a GraphQL subscription clientOperation.

# Interfaces

Clusterable is used as a part of the ClusterConfig in order to create an implementation of the Cluster interface based on any underlying Publisher.
Logger provides an interface allowing the library's internal logging to be handled by third party logging libraries.
Peer represents another node within a cluster.
Peers represents the collection of all peers.
Schema contains information and methods used to analyze a GraphQL schema and generate Update objects.
Update contains information and methods used to help the server decide which subscriptions should be updated.

# Type aliases

MessageType is a string representing a specific type of message.
StaticPeers makes a type out of a slice of Peer object so methods can be attached in order to satisfy the Peers interface.