Skip to content
Snippets Groups Projects
Commit e9c786ce authored by Jan Zickermann's avatar Jan Zickermann
Browse files

OZG-6891 KOP-2735 javadoc: Explain xta client

parent 17cd05cd
Branches
Tags
No related merge requests found
...@@ -84,8 +84,8 @@ public class XtaClient { ...@@ -84,8 +84,8 @@ public class XtaClient {
* </p> * </p>
* *
* @param processMessage The consumer to process each fetched message. * @param processMessage The consumer to process each fetched message.
* @return The transport reports for all fetched/processed messages. Messages which have not been closed have an * @return The transport reports for all fetched/processed messages. A message which has not been closed has an
* {@link XtaMessageStatus#OPEN OPEN} status. If the message has been closed the status is {@link XtaMessageStatus#GREEN GREEN}, * {@link XtaMessageStatus#OPEN OPEN} status. If a message has been closed, the status is either {@link XtaMessageStatus#GREEN GREEN},
* {@link XtaMessageStatus#YELLOW YELLOW} or {@link XtaMessageStatus#RED RED}. * {@link XtaMessageStatus#YELLOW YELLOW} or {@link XtaMessageStatus#RED RED}.
* @throws XtaClientException If a technical problem occurs while fetching messages. * @throws XtaClientException If a technical problem occurs while fetching messages.
*/ */
...@@ -204,8 +204,8 @@ public class XtaClient { ...@@ -204,8 +204,8 @@ public class XtaClient {
* </p> * </p>
* *
* @param messageWithoutMessageId The message to send without id and size. * @param messageWithoutMessageId The message to send without id and size.
* @return The transport report for the sent message. An {@link XtaMessageStatus#OPEN} status indicates that the message was sent with no error or * @return The transport report for the sent message. As long as the reader did not read the message the status is {@link XtaMessageStatus#OPEN}.
* warning. Moreover, the report contains the message metadata, including id and size values set by the server. * Moreover, the report contains the message metadata, including id and size values set by the server.
* @throws XtaClientException If a check fails or a technical problem occurs while sending the message. * @throws XtaClientException If a check fails or a technical problem occurs while sending the message.
*/ */
public XtaTransportReport sendMessage(@NotNull @Valid XtaMessage messageWithoutMessageId) throws XtaClientException { public XtaTransportReport sendMessage(@NotNull @Valid XtaMessage messageWithoutMessageId) throws XtaClientException {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment