Class: Takagi::CoAP::Registries::MessageType

Inherits:
Base
  • Object
show all
Defined in:
lib/takagi/coap/registries/message_type.rb

Overview

CoAP Message Type Registry (RFC 7252 ยง3)

Extensible registry for CoAP message types.

Examples:

Using predefined types

Takagi::CoAP::Registries::MessageType::CONFIRMABLE  # => 0
Takagi::CoAP::Registries::MessageType::ACK          # => 2

Looking up type names

Takagi::CoAP::Registries::MessageType.name_for(0)  # => "Confirmable"

Constant Summary collapse

CON =

Aliases for convenience

CONFIRMABLE
NON = 
NON_CONFIRMABLE
ACK = 
ACKNOWLEDGEMENT
RST = 
RESET

Class Method Summary collapse

Methods inherited from Base

all, clear!, each_value, inherited, metadata_for, name_for, register, registered?, rfc_for, value_for, values

Class Method Details

.acknowledgement?(type) ⇒ Boolean Also known as: ack?

Check if type is acknowledgement

Parameters:

  • type (Integer) —

    Message type

Returns:

  • (Boolean) —

    true if acknowledgement



46
47
48
 
# File 'lib/takagi/coap/registries/message_type.rb', line 46

def self.acknowledgement?(type)
  type == ACKNOWLEDGEMENT
end

.confirmable?(type) ⇒ Boolean

Check if type is confirmable

Parameters:

  • type (Integer) —

    Message type

Returns:

  • (Boolean) —

    true if confirmable



32
33
34
 
# File 'lib/takagi/coap/registries/message_type.rb', line 32

def self.confirmable?(type)
  type == CONFIRMABLE
end

.non_confirmable?(type) ⇒ Boolean

Check if type is non-confirmable

Parameters:

  • type (Integer) —

    Message type

Returns:

  • (Boolean) —

    true if non-confirmable



39
40
41
 
# File 'lib/takagi/coap/registries/message_type.rb', line 39

def self.non_confirmable?(type)
  type == NON_CONFIRMABLE
end

.reset?(type) ⇒ Boolean

Check if type is reset

Parameters:

  • type (Integer) —

    Message type

Returns:

  • (Boolean) —

    true if reset



56
57
58
 
# File 'lib/takagi/coap/registries/message_type.rb', line 56

def self.reset?(type)
  type == RESET
end

.valid?(type) ⇒ Boolean

Check if type is valid

Parameters:

  • type (Integer) —

    Message type

Returns:

  • (Boolean) —

    true if valid



63
64
65
 
# File 'lib/takagi/coap/registries/message_type.rb', line 63

def self.valid?(type)
  (0..3).include?(type)
end