@@ -13,7 +13,7 @@ var _ Worker = (*Consumer)(nil)
1313
1414var errMaxCapacity = errors .New ("max capacity reached" )
1515
16- // Consumer for simple queue using channel
16+ // Consumer for simple queue using buffer channel
1717type Consumer struct {
1818 taskQueue chan QueuedMessage
1919 runFunc func (context.Context , QueuedMessage ) error
@@ -74,7 +74,7 @@ func (s *Consumer) handle(job Job) error {
7474 }
7575}
7676
77- // Run start the worker
77+ // Run to execute new task
7878func (s * Consumer ) Run (task QueuedMessage ) error {
7979 var data Job
8080 _ = json .Unmarshal (task .Bytes (), & data )
@@ -90,7 +90,7 @@ func (s *Consumer) Run(task QueuedMessage) error {
9090 return nil
9191}
9292
93- // Shutdown worker
93+ // Shutdown the worker
9494func (s * Consumer ) Shutdown () error {
9595 if ! atomic .CompareAndSwapInt32 (& s .stopFlag , 0 , 1 ) {
9696 return ErrQueueShutdown
@@ -103,7 +103,7 @@ func (s *Consumer) Shutdown() error {
103103 return nil
104104}
105105
106- // Queue send notification to queue
106+ // Queue send task to the buffer channel
107107func (s * Consumer ) Queue (task QueuedMessage ) error {
108108 if atomic .LoadInt32 (& s .stopFlag ) == 1 {
109109 return ErrQueueShutdown
@@ -117,6 +117,7 @@ func (s *Consumer) Queue(task QueuedMessage) error {
117117 }
118118}
119119
120+ // Request a new task from channel
120121func (s * Consumer ) Request () (QueuedMessage , error ) {
121122 select {
122123 case task , ok := <- s .taskQueue :
@@ -129,7 +130,7 @@ func (s *Consumer) Request() (QueuedMessage, error) {
129130 }
130131}
131132
132- // NewConsumer for struc
133+ // NewConsumer for create new consumer instance
133134func NewConsumer (opts ... Option ) * Consumer {
134135 o := NewOptions (opts ... )
135136 w := & Consumer {
0 commit comments