github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/msg/producer/producer.go (about)

     1  // Copyright (c) 2018 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package producer
    22  
    23  type producer struct {
    24  	Buffer
    25  	Writer
    26  }
    27  
    28  // NewProducer returns a new producer.
    29  func NewProducer(opts Options) Producer {
    30  	return &producer{
    31  		Buffer: opts.Buffer(),
    32  		Writer: opts.Writer(),
    33  	}
    34  }
    35  
    36  func (p *producer) Init() error {
    37  	p.Buffer.Init()
    38  	return p.Writer.Init()
    39  }
    40  
    41  func (p *producer) Produce(m Message) error {
    42  	rm, err := p.Buffer.Add(m)
    43  	if err != nil {
    44  		return err
    45  	}
    46  	return p.Writer.Write(rm)
    47  }
    48  
    49  func (p *producer) Close(ct CloseType) {
    50  	// NB: Must close buffer first, it will start returning errors on
    51  	// new writes immediately. Then if the close type is to wait for consumption
    52  	// it will block until all messages got consumed. If the close type is to drop
    53  	// everything, it will drop everything buffered.
    54  	p.Buffer.Close(ct)
    55  	// Then we can close writer to clean up outstanding go routines.
    56  	p.Writer.Close()
    57  }