Documentation
¶
Index ¶
- type Config
- type PubSubFactoryGenerator
- type Publisher
- type PublisherHandler
- type PublisherSubscriberFactory
- func (pf *PublisherSubscriberFactory) Close() error
- func (pf *PublisherSubscriberFactory) Publisher(topic string) (*Publisher, error)
- func (pf *PublisherSubscriberFactory) QueueSubscribe(topic string, grp string, id string, receiver pubsubs.Receiver, ...) (*Subscription, error)
- func (pf *PublisherSubscriberFactory) Subscribe(topic string, id string, receiver pubsubs.Receiver, ...) (*Subscription, error)
- func (pf *PublisherSubscriberFactory) Wait()
- type QueueGroupSubscriberHandler
- type SubscriberHandler
- type Subscription
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
URL string
ClusterID string
ProjectID string
MessageDeliveryTimeout time.Duration
MaxAckTimeout time.Duration
Log actorkit.Logs
Options []pubsub.Option
Marshaler pubsubs.Marshaler
Unmarshaler pubsubs.Unmarshaler
DefaultConn *nats.Conn
}
Config provides a config struct for instantiating a Publisher type.
type PubSubFactoryGenerator ¶
type PubSubFactoryGenerator func(factory *PublisherSubscriberFactory) pubsubs.PubSubFactory
PubSubFactoryGenerator returns a function which taken a PublisherSubscriberFactory returning a factory for generating publishers and subscribers.
func PubSubFactory ¶
func PubSubFactory(publishers PublisherHandler, subscribers SubscriberHandler, groupSubscribers QueueGroupSubscriberHandler) PubSubFactoryGenerator
PubSubFactory provides a partial function for the generation of a pubsubs.PubSubFactory using the PubSubFactorGenerator function.
type Publisher ¶
type Publisher struct {
// contains filtered or unexported fields
}
Publisher implements the topic publishing provider for the google pubsub layer.
func NewPublisher ¶
func NewPublisher(ctx context.Context, factory *PublisherSubscriberFactory, topic string, sink pubsub.Conn, config *Config) *Publisher
NewPublisher returns a new instance of a Publisher.
type PublisherHandler ¶
type PublisherHandler func(*PublisherSubscriberFactory, string) (pubsubs.Publisher, error)
PublisherHandler defines a function type which takes a giving PublisherFactory and a given topic, returning a new publisher with all related underline specific details added and instantiated.
type PublisherSubscriberFactory ¶
type PublisherSubscriberFactory struct {
// contains filtered or unexported fields
}
PublisherSubscriberFactory implements a Google pubsub Publisher factory which handles creation of publishers for topic publishing and management.
func NewPublisherSubscriberFactory ¶
func NewPublisherSubscriberFactory(ctx context.Context, config Config) (*PublisherSubscriberFactory, error)
NewPublisherSubscriberFactory returns a new instance of publisher factory.
func (*PublisherSubscriberFactory) Close ¶
func (pf *PublisherSubscriberFactory) Close() error
Close closes giving publisher factory and all previous created publishers.
func (*PublisherSubscriberFactory) Publisher ¶
func (pf *PublisherSubscriberFactory) Publisher(topic string) (*Publisher, error)
Publisher returns giving publisher for giving topic, if provided config allows the creation of publisher if not present then a new publisher is created for topic and returned, else an error is returned if not found or due to some other issues.
func (*PublisherSubscriberFactory) QueueSubscribe ¶
func (pf *PublisherSubscriberFactory) QueueSubscribe(topic string, grp string, id string, receiver pubsubs.Receiver, ops []pubsub.SubscriptionOption) (*Subscription, error)
QueueSubscribe returns a new subscription for a giving topic in a given queue group which will be used for processing messages for giving topic from the nats streaming provider. If the topic already has a subscriber then a subscriber with a ever increasing _id is added and returned if a user defined group id is not set, the subscriber receives the giving id as it's queue group name for it's subscription.
func (*PublisherSubscriberFactory) Subscribe ¶
func (pf *PublisherSubscriberFactory) Subscribe(topic string, id string, receiver pubsubs.Receiver, ops []pubsub.SubscriptionOption) (*Subscription, error)
Subscribe returns a new subscription for a giving topic which will be used for processing messages for giving topic from the nats streaming provider. If the topic already has a subscriber then a subscriber with a ever increasing _id is added. The id value is used as a durable name value for the giving subscription. If one exists then that is returned.
func (*PublisherSubscriberFactory) Wait ¶
func (pf *PublisherSubscriberFactory) Wait()
Wait blocks till all generated publishers close and have being reclaimed.
type QueueGroupSubscriberHandler ¶
type QueueGroupSubscriberHandler func(p *PublisherSubscriberFactory, topic string, group string, id string, r pubsubs.Receiver) (pubsubs.Subscription, error)
QueueGroupSubscriberHandler defines a function type which will return a subscription for a queue group.
type SubscriberHandler ¶
type SubscriberHandler func(p *PublisherSubscriberFactory, topic string, id string, r pubsubs.Receiver) (pubsubs.Subscription, error)
SubscriberHandler defines a function type which takes a giving SubscriptionFactory and a given topic, returning a new subscription with all related underline specific details added and instantiated.
type Subscription ¶
type Subscription struct {
// contains filtered or unexported fields
}
Subscription implements a subscriber of a giving topic which is being subscribe to for. It implements the pubsubs.Subscription interface.
func (*Subscription) Error ¶
func (s *Subscription) Error() error
Error returns the associated received error.
func (*Subscription) Group ¶
func (s *Subscription) Group() string
Group returns the group or queue group name of giving subscription.
func (*Subscription) ID ¶
func (s *Subscription) ID() string
ID returns the identification of giving subscription used for durability if supported.
func (*Subscription) Stop ¶
func (s *Subscription) Stop() error
Stop ends giving subscription and it's operation in listening to given topic.
func (*Subscription) Topic ¶
func (s *Subscription) Topic() string
Topic returns the topic name of giving subscription.
Source Files