Skip to content

Commit 2b3fe3d

Browse files
committed
Polish service life state description
1 parent f171b7a commit 2b3fe3d

4 files changed

Lines changed: 11 additions & 11 deletions

File tree

openmessaging-api/src/main/java/io/openmessaging/ServiceLifeState.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,22 @@
99
public enum ServiceLifeState {
1010

1111
/**
12-
* Service just created
12+
* Service has been initialized.
1313
*/
14-
CREATED,
14+
INITIALIZED,
1515

1616
/**
17-
* Service in starting
17+
* Service in starting.
1818
*/
1919
STARTING,
2020

2121
/**
22-
* Service in running
22+
* Service in running.
2323
*/
24-
RUNNING,
24+
STARTED,
2525

2626
/**
27-
* Service has been shutdown
27+
* Service has been shutdown.
2828
*/
29-
SHUTDOWN,
29+
STOPED,
3030
}

openmessaging-api/src/main/java/io/openmessaging/consumer/Consumer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ public interface Consumer extends ServiceLifecycle {
142142
* This call blocks indefinitely until a message is arrives, the timeout expires, or until this {@code PullConsumer}
143143
* is shut down.
144144
*
145-
* @param timeout receive message will blocked at most <code>timeout</code> milliseconds
145+
* @param timeout receive message will blocked at most <code>timeout</code> milliseconds.
146146
* @return the next message received from the bind queues, or null if the consumer is concurrently shut down.
147147
* @throws OMSSecurityException when have no authority to receive messages from this queue.
148148
* @throws OMSTimeOutException when the given timeout elapses before the send operation completes.

openmessaging-api/src/main/java/io/openmessaging/consumer/MessageListener.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ public interface MessageListener {
3333
* <p>
3434
* A message listener should handle different types of {@code Message}.
3535
*
36-
* @param message the received message object
37-
* @param context the context delivered to the consume thread
36+
* @param message the received message object.
37+
* @param context the context delivered to the consume thread.
3838
*/
3939
void onReceived(Message message, Context context);
4040

openmessaging-api/src/main/java/io/openmessaging/consumer/ReceiveResult.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
*/
1212
public interface ReceiveResult extends Result {
1313
/**
14-
* Received message from bind queue in pull model
14+
* Received message from bind queue in pull model.
1515
*
1616
* @return {@link Message} received message
1717
*/

0 commit comments

Comments
 (0)