Uses of Interface org.apache.activemq.artemis.api.core.client.ClientMessage (ActiveMQ Artemis Web 1.1.0.wildfly-010 API)
Date: 2015-12-18

## Uses of Interface
org.apache.activemq.artemis.api.core.client.ClientMessage

- Packages that use ClientMessage
  Package | Description
  --- | ---
  org.apache.activemq.artemis.api.core.client |
  org.apache.activemq.artemis.jms.client |

- - ### Uses of ClientMessage in org.apache.activemq.artemis.api.core.client

    Methods in org.apache.activemq.artemis.api.core.client that return ClientMessage
    Modifier and Type | Method and Description
    --- | ---
    `ClientMessage` | ClientMessage.`acknowledge()` Acknowledges reception of this message.
    `ClientMessage` | ClientSession.`createMessage(boolean durable)` Creates a ClientMessage.
    `ClientMessage` | ClientSession.`createMessage(byte type, boolean durable)` Creates a ClientMessage.
    `ClientMessage` | ClientSession.`createMessage(byte type, boolean durable, long expiration, long timestamp, byte priority)` Creates a ClientMessage.
    `ClientMessage` | ClientMessage.`individualAcknowledge()` Acknowledges reception of a single message.
    `ClientMessage` | ClientMessage.`putBooleanProperty(SimpleString key, boolean value)` Overridden from `Message` to enable fluent API
    `ClientMessage` | ClientMessage.`putBooleanProperty(String key, boolean value)` Overridden from `Message` to enable fluent API
    `ClientMessage` | ClientMessage.`putByteProperty(SimpleString key, byte value)` Overridden from `Message` to enable fluent API
    `ClientMessage` | ClientMessage.`putByteProperty(String key, byte value)` Overridden from `Message` to enable fluent API
    `ClientMessage` | ClientMessage.`putBytesProperty(SimpleString key, byte[] value)` Overridden from `Message` to enable fluent API
    `ClientMessage` | ClientMessage.`putBytesProperty(String key, byte[] value)` Overridden from `Message` to enable fluent API
    `ClientMessage` | ClientMessage.`putCharProperty(SimpleString key, char value)` Overridden from `Message` to enable fluent API
    `ClientMessage` | ClientMessage.`putCharProperty(String key, char value)` Overridden from `Message` to enable fluent API
    `ClientMessage` | ClientMessage.`putDoubleProperty(SimpleString key, double value)` Overridden from `Message` to enable fluent API
    `ClientMessage` | ClientMessage.`putDoubleProperty(String key, double value)` Overridden from `Message` to enable fluent API
    `ClientMessage` | ClientMessage.`putFloatProperty(SimpleString key, float value)` Overridden from `Message` to enable fluent API
    `ClientMessage` | ClientMessage.`putFloatProperty(String key, float value)` Overridden from `Message` to enable fluent API
    `ClientMessage` | ClientMessage.`putIntProperty(SimpleString key, int value)` Overridden from `Message` to enable fluent API
    `ClientMessage` | ClientMessage.`putIntProperty(String key, int value)` Overridden from `Message` to enable fluent API
    `ClientMessage` | ClientMessage.`putLongProperty(SimpleString key, long value)` Overridden from `Message` to enable fluent API
    `ClientMessage` | ClientMessage.`putLongProperty(String key, long value)` Overridden from `Message` to enable fluent API
    `ClientMessage` | ClientMessage.`putShortProperty(SimpleString key, short value)` Overridden from `Message` to enable fluent API
    `ClientMessage` | ClientMessage.`putShortProperty(String key, short value)` Overridden from `Message` to enable fluent API
    `ClientMessage` | ClientMessage.`putStringProperty(SimpleString key, SimpleString value)` Overridden from `Message` to enable fluent API
    `ClientMessage` | ClientMessage.`putStringProperty(String key, String value)` Overridden from `Message` to enable fluent API
    `ClientMessage` | ClientConsumer.`receive()` Receives a message from a queue.
    `ClientMessage` | ClientConsumer.`receive(long timeout)` Receives a message from a queue.
    `ClientMessage` | ClientConsumer.`receiveImmediate()` Receives a message from a queue.
    `ClientMessage` | ClientRequestor.`request(ClientMessage request)` Sends a message to the request address and wait indefinitely for a reply.
    `ClientMessage` | ClientRequestor.`request(ClientMessage request, long timeout)` Sends a message to the request address and wait for the given timeout for a reply.
    `ClientMessage` | ClientMessage.`setBodyInputStream(InputStream bodyInputStream)` Sets the body's IntputStream.
    `ClientMessage` | ClientMessage.`setDeliveryCount(int deliveryCount)` Sets the delivery count for this message.
    `ClientMessage` | ClientMessage.`setOutputStream(OutputStream out)` Sets the OutputStream that will receive the content of a message received in a non blocking way.
    `ClientMessage` | ClientMessage.`writeBodyBufferBytes(byte[] bytes)` Overridden from `Message` to enable fluent API
    `ClientMessage` | ClientMessage.`writeBodyBufferString(String string)` Overridden from `Message` to enable fluent API

    Methods in org.apache.activemq.artemis.api.core.client with parameters of type ClientMessage
    Modifier and Type | Method and Description
    --- | ---
    `void` | MessageHandler.`onMessage(ClientMessage message)` Notifies the MessageHandler that a message has been received.
    `ClientMessage` | ClientRequestor.`request(ClientMessage request)` Sends a message to the request address and wait indefinitely for a reply.
    `ClientMessage` | ClientRequestor.`request(ClientMessage request, long timeout)` Sends a message to the request address and wait for the given timeout for a reply.

  - ### Uses of ClientMessage in org.apache.activemq.artemis.jms.client

    Fields in org.apache.activemq.artemis.jms.client declared as ClientMessage
    Modifier and Type | Field and Description
    --- | ---
    `protected ClientMessage` | ActiveMQMessage.`message`

    Methods in org.apache.activemq.artemis.jms.client that return ClientMessage
    Modifier and Type | Method and Description
    --- | ---
    `ClientMessage` | ActiveMQMessage.`getCoreMessage()`

    Methods in org.apache.activemq.artemis.jms.client with parameters of type ClientMessage
    Modifier and Type | Method and Description
    --- | ---
    `static ActiveMQMessage` | ActiveMQMessage.`createMessage(ClientMessage message, ClientSession session)`
    `void` | JMSMessageListenerWrapper.`onMessage(ClientMessage message)` In this method we apply the JMS acknowledgement and redelivery semantics as per JMS spec

    Constructors in org.apache.activemq.artemis.jms.client with parameters of type ClientMessage
    Constructor and Description
    `ActiveMQBytesMessage(ClientMessage message, ClientSession session)` Constructor on receipt at client side
    `ActiveMQMapMessage(ClientMessage message, ClientSession session)`
    `ActiveMQMessage(ClientMessage message, ClientSession session)` Constructor for when receiving a message from the server
    `ActiveMQObjectMessage(ClientMessage message, ClientSession session)`
    `ActiveMQStreamMessage(ClientMessage message, ClientSession session)`
    `ActiveMQTextMessage(ClientMessage message, ClientSession session)`

Copyright © 2015. All rights reserved.