THabariExpress Class Reference
[HabariExpress component]

This component provides a simple JMS message client. More...

List of all members.

Public Member Functions
	Connect ()
	Calling this method sets Active to True.
	Disconnect ()
	Calling this method sets Active to False.
	Start ()
	Starts (or restarts) a connection's delivery of incoming messages.
	Stop ()
	Temporarily stops a connection's delivery of incoming messages.
	Send (const WideString TextMessage)
	Send a text message.
Public Attributes
Public Properties
Boolean	Active
	Starts and stops the communication.
TBTJMSConnection	Connection
	The current connection.
IDestination	Destination
	The current destination.
IMessageConsumer	MessageConsumer
	The current MessageConsumer.
IMessageProducer	MessageProducer
	The current MessageProducer.
ISession	Session
	The current Session.
Published Properties
Published Properties may be modified at designtime and runtime.
string	CommunicationAdapter
	The client identifier for this connection.
string	Host
	Server address.
TOptionsConsumer	OptionsConsumer
	Consumer options.
TOptionsDestination	OptionsDestination
	Destination options.
TOptionsProducer	OptionsProducer
	Producer options.
TOptionsSession	OptionsSession
	Session options.
TOptionsMessageTransformer	OptionsMessageTransformer
	Message transformer options.
string	Password
	Password.
Integer	Port
	Server port.
string	Username
	User name.
string	Version
	The component version.
Published Events
Published Events may be assigned at designtime and runtime.
TOnBytesMessageEvent	OnBytesMessage
	Incoming JMS bytes message.
TOnObjectMessageEvent	OnObjectMessage
	Incoming JMS object message.
TOnTextMessageEvent	OnTextMessage
	Incoming JMS text message.

---

Detailed Description

This component provides a simple JMS message client.

It provides methods to send and receive messages to Apache ActiveMQ Message Brokers (version 4 and higher) using the STOMP communication protocol.

Required properties are

• Host
• Port
• DestinationName

---

Member Function Documentation

THabariExpress::Connect

(

)

Calling this method sets Active to True.

See also:

Active

THabariExpress::Disconnect

(

)

Calling this method sets Active to False.

See also:

Active

THabariExpress::Start

(

)

Starts (or restarts) a connection's delivery of incoming messages.

A call to start on a connection that has already been started is ignored.

THabariExpress::Stop

(

)

Temporarily stops a connection's delivery of incoming messages.

Delivery can be restarted using the connection's start method.

When the connection is stopped, delivery to all the connection's message consumers is inhibited: synchronous receives block, and messages are not delivered to message listeners.

This call blocks until receives and/or message listeners in progress have completed.

todo does it block ?

Stopping a connection has no effect on its ability to send messages. A call to stop on a connection that has already been stopped is ignored.

---

Member Data Documentation

Boolean THabariExpress::Active

Starts and stops the communication.

See also:

FActive For reading

SetActive For writing

TBTJMSConnection THabariExpress::Connection

The current connection.

Only available if the connection is active.

See also:

GetConnection For reading

IDestination THabariExpress::Destination

The current destination.

Only available if the connection is active.

See also:

GetDestination For reading

IMessageConsumer THabariExpress::MessageConsumer

The current MessageConsumer.

Only available if the connection is active.

See also:

GetMessageConsumer For reading

IMessageProducer THabariExpress::MessageProducer

The current MessageProducer.

Only available if the connection is active.

See also:

GetMessageProducer For reading

ISession THabariExpress::Session

The current Session.

Only available if the connection is active.

See also:

GetSession For reading

string THabariExpress::CommunicationAdapter

The client identifier for this connection.

The purpose of the client identifier is to associate a connection and its objects with a state maintained on behalf of the client by a provider. The only such state identified by the JMS API is that required to support durable subscriptions. Class name of the communication adapter.

See also:

FCommunicationAdapter For reading

SetCommunicationAdapter For writing

string THabariExpress::Host

Server address.

See also:

FHost For reading

SetHost For writing

TOptionsConsumer THabariExpress::OptionsConsumer

Consumer options.

See also:

FOptionsConsumer For reading

TOptionsDestination THabariExpress::OptionsDestination

Destination options.

See also:

FOptionsDestination For reading

TOptionsProducer THabariExpress::OptionsProducer

Producer options.

See also:

FOptionsProducer For reading

TOptionsSession THabariExpress::OptionsSession

Session options.

See also:

FOptionsSession For reading

TOptionsMessageTransformer THabariExpress::OptionsMessageTransformer

Message transformer options.

See also:

FOptionsMessageTransformer For reading

string THabariExpress::Password

Password.

Authorization requires Apache ActiveMQ version 5.1 or newer.

See also:

FPassword For reading

SetPassword For writing

Integer THabariExpress::Port

Server port.

The correct value of this setting depends on the communication protocol. The default value expects that the connection uses the STOMP protocol.

See also:

FPort For reading

SetPort For writing

string THabariExpress::Username

User name.

Authorization requires Apache ActiveMQ version 5.1 or newer.

See also:

FUsername For reading

SetUsername For writing

string THabariExpress::Version

The component version.

See also:

GetVersion For reading

SetVersion For writing

TOnBytesMessageEvent THabariExpress::OnBytesMessage

Incoming JMS bytes message.

See also:

FOnBytesMessage For reading

SetOnBytesMessage For writing

TOnObjectMessageEvent THabariExpress::OnObjectMessage

Incoming JMS object message.

See also:

FOnObjectMessage For reading

SetOnObjectMessage For writing

TOnTextMessageEvent THabariExpress::OnTextMessage

Incoming JMS text message.

See also:

FOnTextMessage For reading

SetOnTextMessage For writing

---