gobayeux

package module

Go to main page

Versions in this module

v2

v2.5.0

Dec 8, 2023

Changes in this version

type Client

+ func (c *Client) Unsubscribe(ch Channel)

v2.4.1

Dec 8, 2023

v2.4.0

Nov 30, 2023

Changes in this version

+ type IgnoreErrorFunc func(error) bool

type Option

+ func WithIgnoreError(f IgnoreErrorFunc) Option

type Options

+ IgnoreError IgnoreErrorFunc

v2.3.0

Oct 26, 2023

Changes in this version

+ type Logger interface

+ Debug func(msg string, args ...any)

+ Error func(msg string, args ...any)

+ Info func(msg string, args ...any)

+ Warn func(msg string, args ...any)

+ WithError func(error) Logger

+ WithField func(key string, value any) Logger

type Option

+ func WithFieldLogger(logger logrus.FieldLogger) Option

+ func WithSlogLogger(logger *slog.Logger) Option

v2.2.0

Oct 9, 2023

Changes in this version

type BadResponseError

+ Body []byte

v2.1.2

Sep 23, 2023

v2.1.1

Sep 22, 2023

Changes in this version

+ const ConnectionTypeCallbackPolling

+ const ConnectionTypeIFrame

+ const ConnectionTypeLongPolling

+ const ErrBadChannel

+ const ErrClientNotConnected

+ const ErrFailedToConnect

+ const ErrMissingClientID

+ const ErrMissingConnectionType

+ const ErrNoSupportedConnectionTypes

+ const ErrNoVersion

+ const ErrTooManyMessages

+ type ActionFailedError struct

+ Action string

+ ErrorMessage string

+ func (e ActionFailedError) Error() string

+ type Advice struct

+ Hosts []string

+ Interval int

+ MultipleClients bool

+ Reconnect string

+ Timeout int

+ func (a Advice) IntervalAsDuration() time.Duration

+ func (a Advice) MustNotRetryOrHandshake() bool

+ func (a Advice) ShouldHandshake() bool

+ func (a Advice) ShouldRetry() bool

+ func (a Advice) TimeoutAsDuration() time.Duration

+ type AlreadyRegisteredError struct

+ func (e AlreadyRegisteredError) Error() string

+ type BadConnectionError struct

+ type BadConnectionTypeError struct

+ ConnectionType string

+ func (e BadConnectionTypeError) Error() string

+ type BadConnectionVersionError struct

+ Version string

+ func (e BadConnectionVersionError) Error() string

+ type BadHandshakeError struct

+ type BadResponseError struct

+ Status string

+ StatusCode int

+ func (e BadResponseError) Error() string

+ type BadStateError struct

+ CurrentState int32

+ FromState int32

+ Message string

+ ToState int32

+ func (e BadStateError) Error() string

+ type BayeuxClient struct

+ func NewBayeuxClient(client *http.Client, transport http.RoundTripper, serverAddress string, ...) (*BayeuxClient, error)

+ func (b *BayeuxClient) Connect(ctx context.Context) ([]Message, error)

+ func (b *BayeuxClient) Disconnect(ctx context.Context) ([]Message, error)

+ func (b *BayeuxClient) Handshake(ctx context.Context) ([]Message, error)

+ func (b *BayeuxClient) Subscribe(ctx context.Context, subscriptions []Channel) ([]Message, error)

+ func (b *BayeuxClient) Unsubscribe(ctx context.Context, subscriptions []Channel) ([]Message, error)

+ func (b *BayeuxClient) UseExtension(ext MessageExtender) error

+ type Channel string

+ const MetaConnect

+ const MetaDisconnect

+ const MetaHandshake

+ const MetaSubscribe

+ const MetaUnsubscribe

+ func (c Channel) HasWildcard() bool

+ func (c Channel) IsValid() bool

+ func (c Channel) Match(other Channel) bool

+ func (c Channel) MatchString(other string) bool

+ func (c Channel) Type() ChannelType

+ type ChannelType string

+ const BroadcastChannel

+ const MetaChannel

+ const ServiceChannel

+ type Client struct

+ func NewClient(serverAddress string, opts ...Option) (*Client, error)

+ func (c *Client) Disconnect(ctx context.Context) error

+ func (c *Client) Publish(ctx context.Context, messages []Message) error

+ func (c *Client) Start(ctx context.Context) <-chan error

+ func (c *Client) Subscribe(ch Channel, receiving chan []Message)

+ func (c *Client) UseExtension(ext MessageExtender) error

+ type ConnectRequestBuilder struct

+ func NewConnectRequestBuilder() *ConnectRequestBuilder

+ func (b *ConnectRequestBuilder) AddClientID(clientID string)

+ func (b *ConnectRequestBuilder) AddConnectionType(connectionType string) error

+ func (b *ConnectRequestBuilder) Build() ([]Message, error)

+ type ConnectionFailedError struct

+ Err error

+ func (e ConnectionFailedError) Error() string

+ func (e ConnectionFailedError) Unwrap() error

+ type ConnectionStateMachine struct

+ func NewConnectionStateMachine() *ConnectionStateMachine

+ func (csm *ConnectionStateMachine) CurrentState() StateRepresentation

+ func (csm *ConnectionStateMachine) IsConnected() bool

+ func (csm *ConnectionStateMachine) ProcessEvent(e Event) error

+ type DisconnectFailedError struct

+ Err error

+ func (e DisconnectFailedError) Error() string

+ func (e DisconnectFailedError) Unwrap() error

+ type DisconnectRequestBuilder struct

+ func NewDisconnectRequestBuilder() *DisconnectRequestBuilder

+ func (b *DisconnectRequestBuilder) AddClientID(clientID string)

+ func (b *DisconnectRequestBuilder) Build() ([]Message, error)

+ type EmptySliceError string

+ func (e EmptySliceError) Error() string

+ type ErrMessageUnparsable string

+ func (e ErrMessageUnparsable) Error() string

+ type Event string

+ type HandshakeFailedError struct

+ Err error

+ func (e HandshakeFailedError) Error() string

+ func (e HandshakeFailedError) Unwrap() error

+ type HandshakeRequestBuilder struct

+ func NewHandshakeRequestBuilder() *HandshakeRequestBuilder

+ func (b *HandshakeRequestBuilder) AddMinimumVersion(version string) error

+ func (b *HandshakeRequestBuilder) AddSupportedConnectionType(connectionType string) error

+ func (b *HandshakeRequestBuilder) AddVersion(version string) error

+ func (b *HandshakeRequestBuilder) Build() ([]Message, error)

+ type InvalidChannelError struct

+ func (e InvalidChannelError) Error() string

+ type Message struct

+ Advice *Advice

+ AuthSuccessful bool

+ Channel Channel

+ ClientID string

+ ConnectionType string

+ Data json.RawMessage

+ Error string

+ Ext map[string]interface{}

+ ID string

+ MinimumVersion string

+ Subscription Channel

+ Successful bool

+ SupportedConnectionTypes []string

+ Timestamp string

+ Version string

+ func (m *Message) GetExt(create bool) map[string]interface{}

+ func (m *Message) ParseError() (MessageError, error)

+ func (m *Message) TimestampAsTime() (time.Time, error)

+ type MessageError struct

+ ErrorArgs []string

+ ErrorCode int

+ ErrorMessage string

+ type MessageExtender interface

+ Incoming func(*Message)

+ Outgoing func(*Message)

+ Registered func(extensionName string, client *BayeuxClient)

+ Unregistered func()

+ type Option func(*Options)

+ func WithHTTPClient(client *http.Client) Option

+ func WithHTTPTransport(transport http.RoundTripper) Option

+ func WithLogger(logger logrus.FieldLogger) Option

+ type Options struct

+ Client *http.Client

+ Logger logrus.FieldLogger

+ Transport http.RoundTripper

+ type StateRepresentation string

+ type SubscribeRequestBuilder struct

+ func NewSubscribeRequestBuilder() *SubscribeRequestBuilder

+ func (b *SubscribeRequestBuilder) AddClientID(clientID string)

+ func (b *SubscribeRequestBuilder) AddSubscription(c Channel) error

+ func (b *SubscribeRequestBuilder) Build() ([]Message, error)

+ type SubscriptionFailedError struct

+ Channels []Channel

+ Err error

+ func (e SubscriptionFailedError) Error() string

+ func (e SubscriptionFailedError) Unwrap() error

+ type UnknownEventTypeError struct

+ func (e UnknownEventTypeError) Error() string

+ type UnsubscribeFailedError struct

+ Channels []Channel

+ Err error

+ func (e UnsubscribeFailedError) Error() string

+ func (e UnsubscribeFailedError) Unwrap() error

+ type UnsubscribeRequestBuilder struct

+ func NewUnsubscribeRequestBuilder() *UnsubscribeRequestBuilder

+ func (b *UnsubscribeRequestBuilder) AddClientID(clientID string)

+ func (b *UnsubscribeRequestBuilder) AddSubscription(c Channel) error

+ func (b *UnsubscribeRequestBuilder) Build() ([]Message, error)

Other modules containing this package

github.com/sigmavirus24/gobayeux

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL