final class MqttProtocolBuilder extends ProtocolBuilder
DSL for building MQTT protocol configuration
Immutable, so all methods return a new occurrence and leave the original unmodified.
- Alphabetic
- By Inheritance
- MqttProtocolBuilder
- ProtocolBuilder
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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()
- 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()
- 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()
- 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()
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def connectTimeout(timeout: Duration): MqttProtocolBuilder
Define the connect timeout
Define the connect timeout
- timeout
the timeout
- returns
a new MqttProtocolBuilder instance
- Annotations
- @Nonnull()
- 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()
- 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()
- 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()
- 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()
- 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()
- 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()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def keepAlive(timeout: Duration): MqttProtocolBuilder
Define the keepAlive timeout
Define the keepAlive timeout
- timeout
the keepAlive timeout
- returns
a new MqttProtocolBuilder instance
- Annotations
- @Nonnull()
- 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()
- 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()
- def mqttVersion_3_1(): MqttProtocolBuilder
Use MQTT 3.1
Use MQTT 3.1
- returns
a new MqttProtocolBuilder instance
- Annotations
- @Nonnull()
- 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()
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def perUserKeyManagerFactory(f: Function[Long, KeyManagerFactory]): MqttProtocolBuilder
Provide a function to set a
KeyManagerFactoryper virtual userProvide a function to set a
KeyManagerFactoryper virtual user- f
the function to feed a
KeyManagerFactoryper virtual user. Input is the virtual user's unique id.- returns
a new MqttProtocolBuilder instance
- Annotations
- @Nonnull()
- def protocol(): Protocol
- Definition Classes
- MqttProtocolBuilder → ProtocolBuilder
- Annotations
- @Override()
- def qosAtLeastOnce(): MqttProtocolBuilder
Use an at-least-once QoS
Use an at-least-once QoS
- returns
a new MqttProtocolBuilder instance
- Annotations
- @Nonnull()
- def qosAtMostOnce(): MqttProtocolBuilder
Use an at-most-once QoS
Use an at-most-once QoS
- returns
a new MqttProtocolBuilder instance
- Annotations
- @Nonnull()
- def qosExactlyOnce(): MqttProtocolBuilder
Use an exactly-once QoS
Use an exactly-once QoS
- returns
a new MqttProtocolBuilder instance
- Annotations
- @Nonnull()
- 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()
- 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()
- 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()
- 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()
- 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()
- 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()
- 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()
- 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()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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()
- 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()
- def toString(): String
- Definition Classes
- AnyRef → Any
- def useTls(useTls: Boolean): MqttProtocolBuilder
Use TLS
Use TLS
- useTls
true to enable TLS
- returns
a new MqttProtocolBuilder instance
- Annotations
- @Nonnull()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()