Packages

c

io.gatling.javaapi.mqtt

MqttProtocolBuilder

final class MqttProtocolBuilder extends ProtocolBuilder

DSL for building MQTT protocol configuration

Immutable, so all methods return a new occurrence and leave the original unmodified.

Linear Supertypes
ProtocolBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MqttProtocolBuilder
  2. ProtocolBuilder
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def broker(hostname: String, port: Int): MqttProtocolBuilder

    Define the MQTT broker address

    Define the MQTT broker address

    hostname

    the hostname

    port

    the port

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  6. def cleanSession(cleanSession: Boolean): MqttProtocolBuilder

    Clean the MQTT session when closing the MQTT connection

    Clean the MQTT session when closing the MQTT connection

    cleanSession

    true to clean the session

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  7. def clientId(clientId: Function[Session, String]): MqttProtocolBuilder

    Define the clientId

    Define the clientId

    clientId

    the clientId, expressed as a function

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  8. def clientId(clientId: String): MqttProtocolBuilder

    Define the clientId

    Define the clientId

    clientId

    the clientId, expressed as a Gatling Expression Language String

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def connectTimeout(timeout: Duration): MqttProtocolBuilder

    Define the connect timeout

    Define the connect timeout

    timeout

    the timeout

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  11. def connectTimeout(timeout: Long): MqttProtocolBuilder

    Define the connect timeout

    Define the connect timeout

    timeout

    the timeout in seconds

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  12. def correlateBy(correlator: CheckBuilder): MqttProtocolBuilder

    Define a check to extract the correlationId when applying check that have to match outbound and inbound messages

    Define a check to extract the correlationId when applying check that have to match outbound and inbound messages

    correlator

    the check to extract the correlationId

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  13. def credentials(userName: Function[Session, String], password: Function[Session, String]): MqttProtocolBuilder

    Define the credentials

    Define the credentials

    userName

    the username, expressed as a function

    password

    the password, expressed as a function

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  14. def credentials(userName: String, password: Function[Session, String]): MqttProtocolBuilder

    Define the credentials

    Define the credentials

    userName

    the username, expressed as a Gatling Expression Language String

    password

    the password, expressed as a function

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  15. def credentials(userName: Function[Session, String], password: String): MqttProtocolBuilder

    Define the credentials

    Define the credentials

    userName

    the username, expressed as a function

    password

    the password, expressed as a Gatling Expression Language String

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  16. def credentials(userName: String, password: String): MqttProtocolBuilder

    Define the credentials

    Define the credentials

    userName

    the username, expressed as a Gatling Expression Language String

    password

    the password, expressed as a Gatling Expression Language String

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def keepAlive(timeout: Duration): MqttProtocolBuilder

    Define the keepAlive timeout

    Define the keepAlive timeout

    timeout

    the keepAlive timeout

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  24. def keepAlive(timeout: Long): MqttProtocolBuilder

    Define the keepAlive timeout

    Define the keepAlive timeout

    timeout

    the keepAlive timeout in seconds

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  25. def lastWill(lw: LastWillBuilder): MqttProtocolBuilder

    Send a LastWill message when closing the connetion

    Send a LastWill message when closing the connetion

    lw

    the last will message

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  26. def mqttVersion_3_1(): MqttProtocolBuilder

    Use MQTT 3.1

    Use MQTT 3.1

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  27. def mqttVersion_3_1_1(): MqttProtocolBuilder

    Use MQTT 3.1.1 (default)

    Use MQTT 3.1.1 (default)

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. def perUserKeyManagerFactory(f: Function[Long, KeyManagerFactory]): MqttProtocolBuilder

    Provide a function to set a KeyManagerFactory per virtual user

    Provide a function to set a KeyManagerFactory per virtual user

    f

    the function to feed a KeyManagerFactory per virtual user. Input is the virtual user's unique id.

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  32. def protocol(): Protocol
    Definition Classes
    MqttProtocolBuilder → ProtocolBuilder
    Annotations
    @Override()
  33. def qosAtLeastOnce(): MqttProtocolBuilder

    Use an at-least-once QoS

    Use an at-least-once QoS

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  34. def qosAtMostOnce(): MqttProtocolBuilder

    Use an at-most-once QoS

    Use an at-most-once QoS

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  35. def qosExactlyOnce(): MqttProtocolBuilder

    Use an exactly-once QoS

    Use an exactly-once QoS

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  36. def reconnectAttemptsMax(reconnectAttemptsMax: Int): MqttProtocolBuilder

    Define the maximum number of reconnections

    Define the maximum number of reconnections

    reconnectAttemptsMax

    the maximum number of reconnections

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  37. def reconnectBackoffMultiplier(multiplier: Float): MqttProtocolBuilder

    Define the reconnect delay exponential backoff multiplier

    Define the reconnect delay exponential backoff multiplier

    multiplier

    the multiplier

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  38. def reconnectDelay(delay: Duration): MqttProtocolBuilder

    Define the delay before reconnecting a crashed connection

    Define the delay before reconnecting a crashed connection

    delay

    the delay

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  39. def reconnectDelay(delay: Long): MqttProtocolBuilder

    Define the delay before reconnecting a crashed connection

    Define the delay before reconnecting a crashed connection

    delay

    the delay in seconds

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  40. def resendBackoffMultiplier(multiplier: Float): MqttProtocolBuilder

    Define the resend delay exponential backoff multiplier

    Define the resend delay exponential backoff multiplier

    multiplier

    the multiplier

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  41. def resendDelay(delay: Duration): MqttProtocolBuilder

    Define the delay before resending a message

    Define the delay before resending a message

    delay

    the delay

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  42. def resendDelay(delay: Long): MqttProtocolBuilder

    Define the delay before resending a message

    Define the delay before resending a message

    delay

    the delay in seconds

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  43. def retain(retain: Boolean): MqttProtocolBuilder

    Instruct the server to retain the message

    Instruct the server to retain the message

    retain

    true to retain

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  44. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  45. def timeoutCheckInterval(interval: Duration): MqttProtocolBuilder

    Define the interval to check for checks timeout

    Define the interval to check for checks timeout

    interval

    the interval

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  46. def timeoutCheckInterval(interval: Long): MqttProtocolBuilder

    Define the interval to check for checks timeout

    Define the interval to check for checks timeout

    interval

    the interval in seconds

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  47. def toString(): String
    Definition Classes
    AnyRef → Any
  48. def useTls(useTls: Boolean): MqttProtocolBuilder

    Use TLS

    Use TLS

    useTls

    true to enable TLS

    returns

    a new MqttProtocolBuilder instance

    Annotations
    @Nonnull()
  49. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  50. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  51. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from ProtocolBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped