Module: CMF

Defined in:
lib/cmf.rb,
lib/cmf/type.rb,
lib/cmf/parser.rb,
lib/cmf/varint.rb,
lib/cmf/builder.rb,
lib/cmf/version.rb,
lib/cmf/dictionary.rb,
lib/cmf/malformed_message_error.rb

Overview

The top-level module for the cmf gem.

Defined Under Namespace

Modules: Dictionary, Type Classes: Builder, MalformedMessageError, Parser, Varint

Constant Summary collapse

VERSION =

This gem's version.

'1.0.1'

Class Method Summary collapse

Class Method Details

.build(obj, dictionary = nil) ⇒ String

Returns An octet string, each character representing one byte of the CMF message.

Returns:

  • (String) —

    An octet string, each character representing one byte of the CMF message.



20
21
22
 
# File 'lib/cmf.rb', line 20

def self.build(obj, dictionary = nil)
  Builder.new(dictionary).build(obj).to_octet
end

.build_hex(obj, dictionary = nil) ⇒ String

Builds hex-encoded a CMF message from an object.

Returns:

  • (String) —

    A hex string, every 2 characters representing one byte of the CMF message.

See Also:



29
30
31
 
# File 'lib/cmf.rb', line 29

def self.build_hex(obj, dictionary = nil)
  Builder.new(dictionary).build(obj).to_hex
end

.parse(message, dictionary = nil) ⇒ Hash

Parses a CMF message into an object.

Parameters:

  • message (String) —

    A CMF message.

Returns:



37
38
39
 
# File 'lib/cmf.rb', line 37

def self.parse(message, dictionary = nil)
  Parser.new(dictionary).parse(message)
end

.parse_hex(message_hex, dictionary = nil) ⇒ Hash

Parses a hex-encoded CMF message into an object.

Parameters:

  • message_hex (String) —

    A hex-encoded CMF message.

Returns:



45
46
47
 
# File 'lib/cmf.rb', line 45

def self.parse_hex(message_hex, dictionary = nil)
  Parser.new(dictionary).parse_hex(message_hex)
end