github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/retention/times.go (about)

     1  // Copyright (c) 2016 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 retention
    22  
    23  import (
    24  	"time"
    25  
    26  	xtime "github.com/m3db/m3/src/x/time"
    27  )
    28  
    29  // FlushTimeStart is the earliest flushable time
    30  func FlushTimeStart(opts Options, t xtime.UnixNano) xtime.UnixNano {
    31  	return FlushTimeStartForRetentionPeriod(opts.RetentionPeriod(), opts.BlockSize(), t)
    32  }
    33  
    34  // FlushTimeStartForRetentionPeriod is the earliest flushable time
    35  func FlushTimeStartForRetentionPeriod(
    36  	retentionPeriod time.Duration, blockSize time.Duration, t xtime.UnixNano) xtime.UnixNano {
    37  	return t.Add(-retentionPeriod).Truncate(blockSize)
    38  }
    39  
    40  // FlushTimeEnd is the latest flushable time
    41  func FlushTimeEnd(opts Options, t xtime.UnixNano) xtime.UnixNano {
    42  	return FlushTimeEndForBlockSize(opts.BlockSize(),
    43  		t.Add(opts.FutureRetentionPeriod()).Add(-opts.BufferPast()))
    44  }
    45  
    46  // FlushTimeEndForBlockSize is the latest flushable time
    47  func FlushTimeEndForBlockSize(blockSize time.Duration, t xtime.UnixNano) xtime.UnixNano {
    48  	return t.Add(-blockSize).Truncate(blockSize)
    49  }