github.com/m3db/m3@v1.5.0/src/dbnode/storage/index/segments.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 index
    22  
    23  import (
    24  	"time"
    25  
    26  	"github.com/m3db/m3/src/m3ninx/index/segment"
    27  	"github.com/m3db/m3/src/x/clock"
    28  )
    29  
    30  type readableSeg struct {
    31  	nowFn                   clock.NowFn
    32  	createdAt               time.Time
    33  	segment                 segment.Segment
    34  	garbageCollectLastCheck time.Time
    35  	garbageCollecting       bool
    36  }
    37  
    38  func newReadableSeg(
    39  	seg segment.Segment,
    40  	opts Options,
    41  ) *readableSeg {
    42  	nowFn := opts.ClockOptions().NowFn()
    43  	return &readableSeg{
    44  		nowFn:     nowFn,
    45  		createdAt: nowFn(),
    46  		segment:   seg,
    47  	}
    48  }
    49  
    50  func (s *readableSeg) Segment() segment.Segment {
    51  	return s.segment
    52  }
    53  
    54  func (s *readableSeg) Age() time.Duration {
    55  	return s.nowFn().Sub(s.createdAt)
    56  }