Class List Method List File List

# Class: VertxMqttServer::MqttWill

Inherits:
  Object
  - Object
  - VertxMqttServer::MqttWill
  show all
Defined in:
  /Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_will.rb

## Overview

Will information from the remote MQTT client

## 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)

- - (true, false) will_flag?
  The will flag for indicating the will message presence.
- - (String) will_message
  The payload for the will as provided by the remote MQTT client.
- - (Fixnum) will_qos
  The QoS level for the will as provided by the remote MQTT client.
- - (true, false) will_retain?
  True if the will must be retained as provided by the remote MQTT client.
- - (String) will_topic
  The topic for the will as provided by the remote MQTT client.

## Class Method Details

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

Returns:

- (`Boolean`)

    17
    18
    19
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_will.rb', line 17

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

### + (`Object`) j_api_type

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

    def self.j_api_type
      @@j_api_type
    end

### + (`Object`) j_class

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

    def self.j_class
      Java::IoVertxMqtt::MqttWill.java_class
    end

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

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

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

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

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

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

## Instance Method Details

### - (`true`, `false`) will_flag?

Returns the will flag for indicating the will message presence

Returns:

- (`true`, `false`) —
  the will flag for indicating the will message presence

Raises:

- (`ArgumentError`)

    33
    34
    35
    36
    37
    38
    39
    40
    41
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_will.rb', line 33

    def will_flag?
      if !block_given?
        if @cached_is_will_flag != nil
          return @cached_is_will_flag
        end
        return @cached_is_will_flag = @j_del.java_method(:isWillFlag, []).call()
      end
      raise ArgumentError, "Invalid arguments when calling will_flag?()"
    end

### - (`String`) will_message

Returns the payload for the will as provided by the remote MQTT client

Returns:

- (`String`) —
  the payload for the will as provided by the remote MQTT client

Raises:

- (`ArgumentError`)

    53
    54
    55
    56
    57
    58
    59
    60
    61
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_will.rb', line 53

    def will_message
      if !block_given?
        if @cached_will_message != nil
          return @cached_will_message
        end
        return @cached_will_message = @j_del.java_method(:willMessage, []).call()
      end
      raise ArgumentError, "Invalid arguments when calling will_message()"
    end

### - (`Fixnum`) will_qos

Returns the QoS level for the will as provided by the remote MQTT client

Returns:

- (`Fixnum`) —
  the QoS level for the will as provided by the remote MQTT client

Raises:

- (`ArgumentError`)

    63
    64
    65
    66
    67
    68
    69
    70
    71
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_will.rb', line 63

    def will_qos
      if !block_given?
        if @cached_will_qos != nil
          return @cached_will_qos
        end
        return @cached_will_qos = @j_del.java_method(:willQos, []).call()
      end
      raise ArgumentError, "Invalid arguments when calling will_qos()"
    end

### - (`true`, `false`) will_retain?

Returns true if the will must be retained as provided by the remote MQTT client

Returns:

- (`true`, `false`) —
  true if the will must be retained as provided by the remote MQTT client

Raises:

- (`ArgumentError`)

    73
    74
    75
    76
    77
    78
    79
    80
    81
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_will.rb', line 73

    def will_retain?
      if !block_given?
        if @cached_is_will_retain != nil
          return @cached_is_will_retain
        end
        return @cached_is_will_retain = @j_del.java_method(:isWillRetain, []).call()
      end
      raise ArgumentError, "Invalid arguments when calling will_retain?()"
    end

### - (`String`) will_topic

Returns the topic for the will as provided by the remote MQTT client

Returns:

- (`String`) —
  the topic for the will as provided by the remote MQTT client

Raises:

- (`ArgumentError`)

    43
    44
    45
    46
    47
    48
    49
    50
    51
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-mqtt-server/mqtt_will.rb', line 43

    def will_topic
      if !block_given?
        if @cached_will_topic != nil
          return @cached_will_topic
        end
        return @cached_will_topic = @j_del.java_method(:willTopic, []).call()
      end
      raise ArgumentError, "Invalid arguments when calling will_topic()"
    end