ppubsub

Documentation

Index

• func InitPubSub(ctx context.Context, p2p *p2p.P2P)
• func NewPubsubStore(ctx context.Context, p2p *p2p.P2P) *pubsubStore
• func Pub(topicName string, message string) error
• type PubSub
  • func JoinPubSub(p2phost *p2p.P2P, clientName string, topicName string) (*PubSub, error)
  • func Sub(local *RESPHandle.WriterHandle, topicName string) (*PubSub, error)
  • func (cr *PubSub) Exit()
  • func (cr *PubSub) PeerList() []peer.ID
  • func (cr *PubSub) PubLoop()
  • func (cr *PubSub) SubLoop()
  • func (cr *PubSub) UpdateUser(username string)
  • func (cr *PubSub) Writer()

Functions

func InitPubSub

func InitPubSub(ctx context.Context, p2p *p2p.P2P)

func NewPubsubStore

func NewPubsubStore(ctx context.Context, p2p *p2p.P2P) *pubsubStore

func Pub

func Pub(topicName string, message string) error

Types

type PubSub

type PubSub struct {
	// Represents the P2P Host for the PubSub
	Host *p2p.P2P

	// Represents the channel of incoming messages
	Inbound chan chatmessage
	// Represents the channel of outgoing messages
	Outbound chan string
	// Represents the channel of chat log messages
	Logs chan chatlog

	// Represents the client of the chat room
	ClientName string
	// Represent the topic of the user in the chat room
	TopicName string
	// contains filtered or unexported fields
}

A structure that represents a PubSub Chat Room

func JoinPubSub

func JoinPubSub(p2phost *p2p.P2P, clientName string, topicName string) (*PubSub, error)

A constructor function that generates and returns a new PubSub for a given P2PHost, username and roomname

func Sub

func Sub(local *RESPHandle.WriterHandle, topicName string) (*PubSub, error)

func (*PubSub) Exit

func (cr *PubSub) Exit()

A method of PubSub that updates the chat room by subscribing to the new topic

func (*PubSub) PeerList

func (cr *PubSub) PeerList() []peer.ID

A method of PubSub that returns a list of all peer IDs connected to it

func (*PubSub) PubLoop

func (cr *PubSub) PubLoop()

A method of PubSub that publishes a chatmessage to the PubSub topic until the pubsub context closes

func (*PubSub) SubLoop

func (cr *PubSub) SubLoop()

A method of PubSub that continously reads from the subscription until either the subscription or pubsub context closes. The recieved message is parsed sent into the inbound channel

func (*PubSub) UpdateUser

func (cr *PubSub) UpdateUser(username string)

A method of PubSub that updates the chat user name

func (*PubSub) Writer

func (cr *PubSub) Writer()