Class List Method List File List

# Class: VertxMqttServer::MqttSubscribeMessage

Inherits:
  Object
  - Object
  - VertxMqttServer::MqttSubscribeMessage
  show all
Includes:
  MqttMessage
Defined in:
  /Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_subscribe_message.rb

## Overview

Represents an MQTT SUBSCRIBE message

## Constant Summary

@@j_api_type =

      Object.new

## Class Method Summary (collapse)

- + (Boolean) accept?(obj)
- + (Object) j_api_type
- + (Object) j_class
- + (Object) unwrap(obj)
- + (Object) wrap(obj)

## Instance Method Summary (collapse)

- - (Fixnum) message_id
  Message identifier.
- - (Array<::VertxMqttServer::MqttTopicSubscription>) topic_subscriptions
  List with topics and related quolity of service levels.

## Class Method Details

### + (`Boolean`) accept?(obj)

Returns:

- (`Boolean`)

    20
    21
    22
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_subscribe_message.rb', line 20

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

### + (`Object`) j_api_type

    29
    30
    31
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_subscribe_message.rb', line 29

    def self.j_api_type
      @@j_api_type
    end

### + (`Object`) j_class

    32
    33
    34
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_subscribe_message.rb', line 32

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

### + (`Object`) unwrap(obj)

    26
    27
    28
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_subscribe_message.rb', line 26

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

### + (`Object`) wrap(obj)

    23
    24
    25
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_subscribe_message.rb', line 23

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

## Instance Method Details

### - (`Fixnum`) message_id

Returns Message identifier

Returns:

- (`Fixnum`) —
  Message identifier

Raises:

- (`ArgumentError`)

    36
    37
    38
    39
    40
    41
    42
    43
    44
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_subscribe_message.rb', line 36

    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
      raise ArgumentError, "Invalid arguments when calling message_id()"
    end

### - (`Array<::VertxMqttServer::MqttTopicSubscription>`) topic_subscriptions

Returns List with topics and related quolity of service levels

Returns:

- (`Array<::VertxMqttServer::MqttTopicSubscription>`) —
  List with topics and related quolity of service levels

Raises:

- (`ArgumentError`)

    46
    47
    48
    49
    50
    51
    52
    53
    54
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_subscribe_message.rb', line 46

    def topic_subscriptions
      if !block_given?
        if @cached_topic_subscriptions != nil
          return @cached_topic_subscriptions
        end
        return @cached_topic_subscriptions = @j_del.java_method(:topicSubscriptions, []).call().to_a.map { |elt| ::Vertx::Util::Utils.safe_create(elt,::VertxMqttServer::MqttTopicSubscription) }
      end
      raise ArgumentError, "Invalid arguments when calling topic_subscriptions()"
    end