THabariXBExpress Class Reference

This class introduces published properties and overloads some methods which are easier to use. More...

Inheritance diagram for THabariXBExpress:
THabariXBExpressBase

List of all members.

Public Member Functions

 THabariXBExpress (TComponent AOwner)
 Create a new HabariXBExpress instance.
 Connect ()
 Connect.
 Disconnect ()
 Disconnect.
IMsgUnitList Get ()
 Synchronous receive messages.
IMsgUnitList Erase ()
 The Erase method allows to erase messages in xmlBlaster.
IPublishReturnQos Publish (const AnsiString Msg)
 Publish the message to the configured destination.
ISubscribeReturnQos Subscribe ()
 Subscribe to messages.
IInterfaceList UnSubscribe ()
 The UnSubscribe method allows to cancel message subscriptions in xmlBlaster.

Public Attributes

Boolean Active
 Active.
AnsiString AboutXB
 Version information.
 Host
 Server Host.
 Port
 Server Port.
 OnPing
 Event handler which will be called when the Server sends a ping message to the client.
 OnUpdate
 Event handler which will be called when the Server sends a message to the client.
TOptionsConnect OptionsConnect
 Connect options.
TOptionsDisconnect OptionsDisconnect
 Disconnect options.
TOptionsErase OptionsErase
 Erase options.
TOptionsGet OptionsGet
 Get options.
TOptionsPublish OptionsPublish
 MessageTransformer options.
TOptionsSubscribe OptionsSubscribe
 Subscribe options.
TOptionsUnSubscribe OptionsUnSubscribe
 UnSubscribe options.

Detailed Description

This class introduces published properties and overloads some methods which are easier to use.


Member Function Documentation

IMsgUnitList THabariXBExpress::Erase (  ) 

The Erase method allows to erase messages in xmlBlaster.

Returns:
A list of IMsgUnit (see TMsgUnit)
IMsgUnitList THabariXBExpress::Get (  ) 

Synchronous receive messages.

Returns:
A list of IMsgUnit (see TMsgUnit)
IPublishReturnQos THabariXBExpress::Publish ( const AnsiString  Msg  ) 

Publish the message to the configured destination.

Parameters:
Msg the message content
ISubscribeReturnQos THabariXBExpress::Subscribe (  ) 

Subscribe to messages.

Returns:
a TSubscribeReturnQos
IInterfaceList THabariXBExpress::UnSubscribe (  ) 

The UnSubscribe method allows to cancel message subscriptions in xmlBlaster.

To unSubscribe you pass the subscriptionId you got from subscribe.


Member Data Documentation

Version information.

See also:
FAboutXB For reading

Active.

See also:
FActive For reading
SetActive For writing

Connect options.

See also:
FOptionsConnect For reading

Disconnect options.

See also:
FOptionsDisconnect For reading

Erase options.

See also:
FOptionsErase For reading

Get options.

See also:
FOptionsGet For reading
SetOptionsGet For writing

MessageTransformer options.

Publish options.

See also:
FOptionsPublish For reading

Subscribe options.

See also:
FOptionsSubscribe For reading

UnSubscribe options.

See also:
FOptionsUnSubscribe For reading

Server Port.

Default: 7607

Reimplemented from THabariXBExpressBase.


The documentation for this class was generated from the following file:

Generated on Tue Apr 20 11:30:18 2010 for Habari XB Client by  doxygen 1.6.1