Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

pushflo

package module

Go to main page

Versions in this module

v0

v0.2.0

Jul 14, 2026

Changes in this version

+ const DefaultConsoleURL

type Message

+ ClientID string

type PublishResult

+ ChannelSlug string

+ ClientID string

+ CreatedAt string

+ EventType string

v0.1.0

Jul 14, 2026

Changes in this version

+ const DefaultBaseURL

+ var ErrNotImplemented = errors.New("pushflo: management API not implemented yet")

+ func IsValidChannelSlug(s string) bool

+ func ToChannelSlug(s string) string

+ type AuthenticationError struct

+ type Channel struct

+ Description string

+ IsPrivate bool

+ MessageCount int

+ Name string

+ Slug string

+ type ChannelInput struct

+ Description string

+ IsPrivate bool

+ Name string

+ Slug string

+ type Client struct

+ func NewClient(ctx context.Context, opts ClientOptions) (*Client, error)

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

+ func (c *Client) Destroy()

+ func (c *Client) Disconnect() error

+ func (c *Client) IsConnected() bool

+ func (c *Client) OnConnected(fn func(clientID string))

+ func (c *Client) OnConnectionChange(fn func(ConnectionState))

+ func (c *Client) OnDisconnected(fn func(reason string))

+ func (c *Client) OnError(fn func(error))

+ func (c *Client) OnMessage(fn func(Message))

+ func (c *Client) State() ConnectionState

+ func (c *Client) Subscribe(channel string, h SubscriptionHandlers) (*Subscription, error)

+ type ClientOptions struct

+ AutoConnect bool

+ AutoReconnect bool

+ BaseURL string

+ ConnectionTimeout time.Duration

+ Debug bool

+ HeartbeatInterval time.Duration

+ Logger *log.Logger

+ MaxReconnectAttempts int

+ MaxReconnectDelay time.Duration

+ PublishKey string

+ ReconnectDelay time.Duration

+ type ConnectionError struct

+ type ConnectionState string

+ const StateConnected

+ const StateConnecting

+ const StateDisconnected

+ const StateError

+ type Error struct

+ Code string

+ Err error

+ Message string

+ Retryable bool

+ func (e *Error) Error() string

+ func (e *Error) Unwrap() error

+ type Management struct

+ func NewManagement(opts ManagementOptions) (*Management, error)

+ func (m *Management) CreateChannel(ctx context.Context, in ChannelInput) (*Channel, error)

+ func (m *Management) CreateProject(ctx context.Context, in Project) (*Project, error)

+ func (m *Management) DeleteChannel(ctx context.Context, slug string) error

+ func (m *Management) GetChannel(ctx context.Context, slug string) (*Channel, error)

+ func (m *Management) GetMessageHistory(ctx context.Context, channel string, page, pageSize int) ([]Message, *Pagination, error)

+ func (m *Management) ListChannels(ctx context.Context, page, pageSize int) ([]Channel, *Pagination, error)

+ func (m *Management) ListProjects(ctx context.Context) ([]Project, *Pagination, error)

+ func (m *Management) UpdateChannel(ctx context.Context, slug string, in ChannelInput) (*Channel, error)

+ type ManagementOptions struct

+ BaseURL string

+ Debug bool

+ ManagementKey string

+ Timeout time.Duration

+ type Message struct

+ Channel string

+ Content json.RawMessage

+ EventType string

+ ID string

+ Timestamp time.Time

+ func (m Message) Unmarshal(v any) error

+ type NetworkError struct

+ type Pagination struct

+ Page int

+ PageSize int

+ Total int

+ TotalPages int

+ type Project struct

+ ChannelCount int

+ CredentialCount int

+ Description string

+ Name string

+ Slug string

+ type PublishOption func(*publishConfig)

+ func WithEventType(t string) PublishOption

+ type PublishResult struct

+ Delivered int

+ ID string

+ type Publisher struct

+ func NewPublisher(opts PublisherOptions) (*Publisher, error)

+ func (p *Publisher) Publish(ctx context.Context, channel string, content any, opts ...PublishOption) (*PublishResult, error)

+ func (p *Publisher) PublishRaw(ctx context.Context, channel string, content json.RawMessage, ...) (*PublishResult, error)

+ func (p *Publisher) PublishSealed(ctx context.Context, channel string, sealer *envelope.Sealer, v any, ...) (*PublishResult, error)

+ type PublisherOptions struct

+ BaseURL string

+ Debug bool

+ HTTPClient *http.Client

+ RetryAttempts int

+ SecretKey string

+ Timeout time.Duration

+ type SlugValidation struct

+ Error string

+ Suggestion string

+ Valid bool

+ func ValidateChannelSlug(s string) SlugValidation

+ type Subscription struct

+ func (s *Subscription) Channel() string

+ func (s *Subscription) Unsubscribe() error

+ type SubscriptionHandlers struct

+ OnError func(error)

+ OnMessage func(Message)

+ OnSubscribed func()

+ OnUnsubscribed func()

+ type ValidationError struct