class Comet::FileOption

This type is available in Comet 23.3.7 and later.
constants for more information.
FileOption defines the configuration for Comet Server to log live events to a file. See the SEVT_
FileOption is a typed class wrapper around the underlying Comet Server API data structure.

def clear

def clear
  @filename = ''
  @allow_event_types = []
  @level = ''
  @pruning_limit = 0
  @unknown_json_fields = {}
end

def from_hash(obj)

Parameters:
  • obj (Hash) -- The complete object as a Ruby hash
def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
  obj.each do |k, v|
    case k
    when 'Filename'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @filename = v
    when 'AllowEventTypes'
      if v.nil?
        @allow_event_types = []
      else
        @allow_event_types = Array.new(v.length)
        v.each_with_index do |v1, i1|
          raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric
          @allow_event_types[i1] = v1
        end
      end
    when 'Level'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @level = v
    when 'PruningEnabled'
      @pruning_enabled = v
    when 'PruningLimit'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
      @pruning_limit = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

def from_json(json_string)

Parameters:
  • json_string (String) -- The complete object in JSON format
def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
  from_hash(JSON.parse(json_string))
end

def initialize

def initialize
  clear
end

def to_h

Returns:
  • (Hash) - The complete object as a Ruby hash
def to_h
  to_hash
end

def to_hash

Returns:
  • (Hash) - The complete object as a Ruby hash
def to_hash
  ret = {}
  ret['Filename'] = @filename
  unless @allow_event_types.nil?
    ret['AllowEventTypes'] = @allow_event_types
  end
  unless @level.nil?
    ret['Level'] = @level
  end
  unless @pruning_enabled.nil?
    ret['PruningEnabled'] = @pruning_enabled
  end
  unless @pruning_limit.nil?
    ret['PruningLimit'] = @pruning_limit
  end
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

def to_json(options = {})

Returns:
  • (String) - The complete object as a JSON string
def to_json(options = {})
  to_hash.to_json(options)
end