subscription

Documentation

Index

• Constants
• Variables
• type Chan
• type ChanID
• type ChanInfo
  • func NewChanInfo(id ChanID, type_ ChanType) *ChanInfo
• type ChanType
• type Channel
• type ChannelUpdate
• type Interface
• type Message
• type Server
• type Subscribe
• type Subscriber
  • func (s *Subscriber) Notify(msg Message) error
• type SubscriberID
• type Update

Constants

const (
	SubscriberSubscribe   int64 = 1
	SubscriberUnsubscribe       = 2
	SubscriberUpdate            = 5
)

const (
	ChanCreate int64 = 1
	ChanDelete       = 2
	ChanUpdate       = 3
)

Variables

var (
	ErrChanNotExist      = "channel does not exist"
	ErrChanAlreadyExists = "channel already exists"
	ErrChanClosed        = "subscribe channel is closed"
	ErrAlreadySubscribed = "already subscribed"
	ErrNotSubscribed     = "not subscribed"
	ErrNotPublisher      = "not publisher"
)

var (
	ErrUnknownFlag = errors.New("unknown flag")
)

Types

type Chan

type Chan struct {
}

type ChanID

type ChanID string

ChanID is a unique identifier for a channel.

type ChanInfo

type ChanInfo struct {
	ID   ChanID
	Type ChanType

	Muted   bool
	Blocked bool
	Closed  bool

	Parent *ChanID
	Child  []ChanID
}

func NewChanInfo

func NewChanInfo(id ChanID, type_ ChanType) *ChanInfo

type ChanType

type ChanType int32

const (
	ChanTypeUnknown ChanType = 0
)

type Channel

type Channel interface {
	Subscribe(id SubscriberID, extra interface{}) error

	Unsubscribe(id SubscriberID) error

	Update(i *ChanInfo) error

	Publish(msg Message) error

	Close() error
}

type ChannelUpdate

type ChannelUpdate struct {
	Flag int64

	Extra interface{}
}

type Interface

type Interface interface {
	PublishMessage(id ChanID, message Message) error
}

type Message

type Message interface {
	GetFrom() SubscriberID

	// GetChatMessage convert message body to *messages.ChatMessage
	GetChatMessage() (*messages.ChatMessage, error)
}

Message is a message that can be publishing to channel.

type Server

type Server interface {
	Subscribe

	Run() error
}

type Subscribe

type Subscribe interface {
	Interface

	SetGateInterface(gate gate.DefaultGateway)

	UpdateSubscriber(id ChanID, updates []Update) error

	UpdateChannel(id ChanID, update ChannelUpdate) error
}

type Subscriber

type Subscriber struct {
	ID   string
	Type string
}

func (*Subscriber) Notify

func (s *Subscriber) Notify(msg Message) error

type SubscriberID

type SubscriberID string

type Update

type Update struct {
	Flag int64
	ID   SubscriberID

	Extra interface{}
}