Class: VertxMqtt::MqttPublishMessage

Inherits:
Object
  • Object
show all
Includes:
MqttMessage
Defined in:
/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mqtt/mqtt_publish_message.rb

Overview

Represents an MQTT PUBLISH message

Constant Summary

@@j_api_type =
Object.new

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Boolean) accept?(obj)

Returns:

  • (Boolean)


21
22
23
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mqtt/mqtt_publish_message.rb', line 21

def @@j_api_type.accept?(obj)
  obj.class == MqttPublishMessage
end

+ (Object) j_api_type



30
31
32
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mqtt/mqtt_publish_message.rb', line 30

def self.j_api_type
  @@j_api_type
end

+ (Object) j_class



33
34
35
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mqtt/mqtt_publish_message.rb', line 33

def self.j_class
  Java::IoVertxMqttMessages::MqttPublishMessage.java_class
end

+ (Object) unwrap(obj)



27
28
29
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mqtt/mqtt_publish_message.rb', line 27

def @@j_api_type.unwrap(obj)
  obj.j_del
end

+ (Object) wrap(obj)



24
25
26
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mqtt/mqtt_publish_message.rb', line 24

def @@j_api_type.wrap(obj)
  MqttPublishMessage.new(obj)
end

Instance Method Details

- (true, false) isDup

Returns If the message is a duplicate

Returns:

  • (true, false)
    If the message is a duplicate


83
84
85
86
87
88
89
90
91
92
93
94
95
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mqtt/mqtt_publish_message.rb', line 83

def dup?
  if !block_given?
    if @cached_is_dup != nil
      return @cached_is_dup
    end
    return @cached_is_dup = @j_del.java_method(:isDup, []).call()
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling dup?()"
  end
end

- (Fixnum) messageId

Returns Message identifier

Returns:

  • (Fixnum)
    Message identifier


98
99
100
101
102
103
104
105
106
107
108
109
110
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mqtt/mqtt_publish_message.rb', line 98

def message_id
  if !block_given?
    if @cached_message_id != nil
      return @cached_message_id
    end
    return @cached_message_id = @j_del.java_method(:messageId, []).call()
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling message_id()"
  end
end

- (::Vertx::Buffer) payload

Returns Payload message

Returns:



38
39
40
41
42
43
44
45
46
47
48
49
50
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mqtt/mqtt_publish_message.rb', line 38

def payload
  if !block_given?
    if @cached_payload != nil
      return @cached_payload
    end
    return @cached_payload = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:payload, []).call(),::Vertx::Buffer)
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling payload()"
  end
end

- (:AT_MOST_ONCE, ...) qosLevel

Returns Quality of service level

Returns:

  • (:AT_MOST_ONCE, :AT_LEAST_ONCE, :EXACTLY_ONCE, :FAILURE)
    Quality of service level


113
114
115
116
117
118
119
120
121
122
123
124
125
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mqtt/mqtt_publish_message.rb', line 113

def qos_level
  if !block_given?
    if @cached_qos_level != nil
      return @cached_qos_level
    end
    return @cached_qos_level = @j_del.java_method(:qosLevel, []).call().name.intern
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling qos_level()"
  end
end

- (true, false) isRetain

Returns If the message needs to be retained

Returns:

  • (true, false)
    If the message needs to be retained


53
54
55
56
57
58
59
60
61
62
63
64
65
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mqtt/mqtt_publish_message.rb', line 53

def retain?
  if !block_given?
    if @cached_is_retain != nil
      return @cached_is_retain
    end
    return @cached_is_retain = @j_del.java_method(:isRetain, []).call()
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling retain?()"
  end
end

- (String) topicName

Returns Topic on which the message was published

Returns:

  • (String)
    Topic on which the message was published


68
69
70
71
72
73
74
75
76
77
78
79
80
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mqtt/mqtt_publish_message.rb', line 68

def topic_name
  if !block_given?
    if @cached_topic_name != nil
      return @cached_topic_name
    end
    return @cached_topic_name = @j_del.java_method(:topicName, []).call()
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling topic_name()"
  end
end