Skip to content

Commit

Permalink
Missing doc strings
Browse files Browse the repository at this point in the history
  • Loading branch information
Bret Ambrose committed Jan 14, 2025
1 parent 8ada5b9 commit 543937a
Showing 1 changed file with 18 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@

package software.amazon.awssdk.crt.iot;

import software.amazon.awssdk.crt.mqtt.MqttClientConnection;
import software.amazon.awssdk.crt.mqtt5.Mqtt5Client;

/**
* Class to configure an MQTT-based request response client.
*/
Expand Down Expand Up @@ -46,7 +43,7 @@ public MqttRequestResponseClientOptionsBuilder withMaxStreamingSubscriptions(int
}

/**
* Sets the Duration, in seconds, that a request-response operation will wait for completion before giving up
* Sets the duration, in seconds, that a request-response operation will wait for completion before giving up
*
* @param operationTimeoutSeconds duration, in seconds, that a request-response operation will wait for completion before giving up
* @return the builder instance
Expand All @@ -58,35 +55,49 @@ public MqttRequestResponseClientOptionsBuilder withOperationTimeoutSeconds(int o
}

/**
*
* Creates a new MqttRequestResponseClientOptions instance based on current builder configuration
* @return
*/
public MqttRequestResponseClientOptions build() {
return new MqttRequestResponseClientOptions(this.options);
}
}

MqttRequestResponseClientOptions() {
private MqttRequestResponseClientOptions() {
}

MqttRequestResponseClientOptions(MqttRequestResponseClientOptions options) {
private MqttRequestResponseClientOptions(MqttRequestResponseClientOptions options) {
this.maxRequestResponseSubscriptions = options.maxRequestResponseSubscriptions;
this.maxStreamingSubscriptions = options.maxStreamingSubscriptions;
this.operationTimeoutSeconds = options.operationTimeoutSeconds;
}

/**
* Creates a new builder for MqttRequestResponseClientOptions instances
*
* @return a new builder for MqttRequestResponseClientOptions instances
*/
public static MqttRequestResponseClientOptions.MqttRequestResponseClientOptionsBuilder builder() {
return new MqttRequestResponseClientOptions.MqttRequestResponseClientOptionsBuilder();
}

/**
* @return the maximum number of subscriptions that the client will concurrently use for request-response operations
*/
int getMaxRequestResponseSubscriptions() {
return this.maxRequestResponseSubscriptions;
}

/**
* @return the maximum number of subscriptions that the client will concurrently use for streaming operations
*/
int getMaxStreamingSubscriptions() {
return this.maxStreamingSubscriptions;
}

/**
* @return the duration, in seconds, that a request-response operation will wait for completion before giving up
*/
int getOperationTimeoutSeconds() {
return this.operationTimeoutSeconds;
}
Expand Down

0 comments on commit 543937a

Please sign in to comment.