Habari Client for Artemis  6.8
Object Pascal STOMP client library for ActiveMQ Artemis
TBTAbstractConnectionFactory Class Reference

A ConnectionFactory is used for creating Connections. More...

Inheritance diagram for TBTAbstractConnectionFactory:
IConnectionFactory IConnectionFactory TBTConnectionFactory

Public Member Functions

TBTConnection CreateMQConnection ()
 Creates a connection with the default user identity. More...
 
TBTConnection CreateMQConnection (const string UserName, const string Password)
 Creates a connection with the specified user identity. More...
 
IConnection CreateConnection ()
 Creates a connection with the default user identity. More...
 
IConnection CreateConnection (const string UserName, const string Password)
 Creates a connection with the specified user identity. More...
 
IClientLibraryInfo ClientLibraryInfo ()
 Returns the client library information.
 

Public Attributes

string ClientID
 The clientID to use for the created connection. More...
 
Integer ConnectTimeOut
 Connect time out (in milliseconds) More...
 
string UserName
 The userName used by connections created by this factory. More...
 
string Password
 The password used for connections created from this factory. More...
 
string BrokerURL
 The connection URL used to connect to the broker. More...
 
Integer SendTimeOut
 Send time out. More...
 

Detailed Description

A ConnectionFactory is used for creating Connections.

A ConnectionFactory object encapsulates a set of connection configuration parameters that has been defined by an administrator.

A client uses it to create a connection with a provider.

Member Function Documentation

◆ CreateConnection() [1/2]

IConnection TBTAbstractConnectionFactory::CreateConnection ( )

Creates a connection with the default user identity.

The connection is created in stopped mode. No messages will be delivered until the Connection.Start method is explicitly called.

◆ CreateConnection() [2/2]

IConnection TBTAbstractConnectionFactory::CreateConnection ( const string  UserName,
const string  Password 
)

Creates a connection with the specified user identity.

The connection is reated in stopped mode. No messages will be delivered until the Connection.Start method is explicitly called.

◆ CreateMQConnection() [1/2]

TBTConnection TBTAbstractConnectionFactory::CreateMQConnection ( )

Creates a connection with the default user identity.

The connection is created in stopped mode. No messages will be delivered until the Connection.Start method is explicitly called.

◆ CreateMQConnection() [2/2]

TBTConnection TBTAbstractConnectionFactory::CreateMQConnection ( const string  UserName,
const string  Password 
)

Creates a connection with the specified user identity.

The connection is created in stopped mode. No messages will be delivered until the Connection.Start method is explicitly called.

Member Data Documentation

◆ BrokerURL

string TBTAbstractConnectionFactory::BrokerURL

The connection URL used to connect to the broker.

See also
GetBrokerURL For reading
SetBrokerURL For writing

◆ ClientID

string TBTAbstractConnectionFactory::ClientID

The clientID to use for the created connection.

Note that this can only be used by one connection at once so generally its a better idea to set the clientID on a Connection.

See also
FClientID For reading
FClientID For writing

◆ ConnectTimeOut

Integer TBTAbstractConnectionFactory::ConnectTimeOut

Connect time out (in milliseconds)

Note
Experimental feature. Implemented in Internet Direct (Indy) only.
See also
FConnectTimeOut For reading
SetConnectTimeOut For writing

◆ Password

string TBTAbstractConnectionFactory::Password

The password used for connections created from this factory.

See also
FPassword For reading
FPassword For writing

◆ SendTimeOut

Integer TBTAbstractConnectionFactory::SendTimeOut

Send time out.

Note
Experimental feature.
See also
FSendTimeOut For reading
FSendTimeOut For writing

◆ UserName

string TBTAbstractConnectionFactory::UserName

The userName used by connections created by this factory.

See also
FUserName For reading
FUserName For writing