module Hitimes

The top level module containing the contents of the hitimes library

use the library with:

require 'hitimes'

Hitimes Constants and module methods

Constants

MutexedStats: MutexedStats is the start of a threadsafe Stats class. Currently, on MRI Ruby the Stats object is already threadsafe, so there is no need to use MutexedStats.
VERSION

Public Class Methods

clock_name ()

Source

# File lib/hitimes/instant.rb, line 29
def clock_name
  case CLOCK_ID
  when Symbol
    CLOCK_ID.to_s
  else
    const = Process.constants.grep(/CLOCK/).find do |id|
      Process.const_get(id) == CLOCK_ID
    end
    "Process::#{const}"
  end
end

The human readable clock name of the CLOCK_ID as a string

Returns

Returns the clock name as a String

measure (&block)

Source

# File lib/hitimes.rb, line 24
def self.measure(&block)
  Hitimes::Interval.measure(&block)
end

Hitimes.measure { } -> Float

Times the execution of the block, returning the number of seconds it took

raw_instant ()

Source

# File lib/hitimes/instant.rb, line 21
def raw_instant
  Process.clock_gettime(::Hitimes::CLOCK_ID, :nanosecond)
end

Get the raw instant

Examples:

Hitimes.raw_instant

Returns

Returns the raw instant value

Public

Constants

CLOCK_ID: The clock_id to use in Process.clock_gettime

Private Instance Methods

raw_instant ()

Source

# File lib/hitimes/instant.rb, line 21
def raw_instant
  Process.clock_gettime(::Hitimes::CLOCK_ID, :nanosecond)
end

Get the raw instant

Examples:

Hitimes.raw_instant

Returns

Returns the raw instant value

Internal

Constants

NANOSECONDS_PER_SECOND: The fraction of second of a nanosecond

Private Instance Methods

clock_name ()

Source

# File lib/hitimes/instant.rb, line 29
def clock_name
  case CLOCK_ID
  when Symbol
    CLOCK_ID.to_s
  else
    const = Process.constants.grep(/CLOCK/).find do |id|
      Process.const_get(id) == CLOCK_ID
    end
    "Process::#{const}"
  end
end

The human readable clock name of the CLOCK_ID as a string

Returns

Returns the clock name as a String