Skip to content

Commit e10bcb0

Browse files
committed
Clean javadoc
1 parent ac913f2 commit e10bcb0

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

src/main/java/com/iexec/worker/pubsub/SubscriptionService.java

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ public SubscriptionService(WorkerConfigurationService workerConfigurationService
3838
}
3939

4040
/**
41-
* Subscribe to a topic and handle {@link TaskNotification}.
41+
* Subscribe to a task's topic and handle {@link TaskNotification}.
4242
*
43-
* @param chainTaskId
43+
* @param chainTaskId id of the task to which to subscribe
4444
*/
4545
public synchronized void subscribeToTopic(String chainTaskId) {
4646
String topic = getTaskTopicName(chainTaskId);
@@ -70,6 +70,13 @@ public void unsubscribeFromTopic(String chainTaskId) {
7070
log.info("Unsubscribed from topic [chainTaskId:{}]", chainTaskId);
7171
}
7272

73+
/**
74+
* Check whether or not the worker is subscribed
75+
* to a task's topic.
76+
*
77+
* @param chainTaskId id of the task to check
78+
* @return true if subscribed, false otherwise
79+
*/
7380
public boolean isSubscribedToTopic(String chainTaskId) {
7481
return this.chainTaskIdToSubscription.containsKey(chainTaskId);
7582
}
@@ -94,6 +101,10 @@ private String getTaskTopicName(String chainTaskId) {
94101
return "/topic/task/" + chainTaskId;
95102
}
96103

104+
/**
105+
* An implementation of {@link StompFrameHandler} that
106+
* handles received task notifications.
107+
*/
97108
@AllArgsConstructor
98109
public class MessageHandler implements StompFrameHandler {
99110

0 commit comments

Comments
 (0)