Habari STOMP Client for ActiveMQ 9.4
Object Pascal STOMP client library for Apache ActiveMQ
Loading...
Searching...
No Matches
IConnectionFactory Interface Reference

Encapsulates a set of connection configuration parameters that has been defined by an administrator. More...

Inheritance diagram for IConnectionFactory:
TBTAbstractConnectionFactory TBTConnectionFactory

Public Member Functions

IConnection CreateConnection ()
 Creates a connection with the default user identity.
IConnection CreateConnection (const string Username, const string Password)
 Creates a connection with the specified user identity.
IMQContext CreateContext ()
 Creates a messaging context with default settings.
IMQContext CreateContext (const TAcknowledgementMode AcknowledgeMode)
 Creates a messaging context with the specified acknowledgment mode.
IMQContext CreateContext (const string Username, const string Password)
 Creates a messaging context with the specified user credentials.
IMQContext CreateContext (const string Username, const string Password, const TAcknowledgementMode AcknowledgeMode)
 Creates a messaging context with the specified user credentials and acknowledgment mode.

Detailed Description

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 IConnectionFactory::CreateConnection ( )

Creates a connection with the default user identity.

The connection is created in a stopped mode, meaning no messages will be delivered until the Connection.Start method is explicitly called.

Returns
An IConnection object representing the created connection.

Implemented in TBTAbstractConnectionFactory.

◆ CreateConnection() [2/2]

IConnection IConnectionFactory::CreateConnection ( const string Username,
const string Password )

Creates a connection with the specified user identity.

The connection is created in a stopped mode, meaning no messages will be delivered until the Connection.Start method is explicitly called.

Parameters
UsernameThe username for the connection.
PasswordThe password for the connection.
Returns
An IConnection object representing the created connection.

Implemented in TBTAbstractConnectionFactory.

◆ CreateContext() [1/4]

IMQContext IConnectionFactory::CreateContext ( )

Creates a messaging context with default settings.

Returns
An IMQContext instance representing the created context.

Implemented in TBTAbstractConnectionFactory.

◆ CreateContext() [2/4]

IMQContext IConnectionFactory::CreateContext ( const string Username,
const string Password )

Creates a messaging context with the specified user credentials.

Parameters
UsernameThe username for the context.
PasswordThe password for the context.
Returns
An IMQContext instance representing the created context.

Implemented in TBTAbstractConnectionFactory.

◆ CreateContext() [3/4]

IMQContext IConnectionFactory::CreateContext ( const string Username,
const string Password,
const TAcknowledgementMode AcknowledgeMode )

Creates a messaging context with the specified user credentials and acknowledgment mode.

Parameters
UsernameThe username for the context.
PasswordThe password for the context.
AcknowledgeModeThe acknowledgment mode for the context.
Returns
An IMQContext instance representing the created context.

Implemented in TBTAbstractConnectionFactory.

◆ CreateContext() [4/4]

IMQContext IConnectionFactory::CreateContext ( const TAcknowledgementMode AcknowledgeMode)

Creates a messaging context with the specified acknowledgment mode.

Parameters
AcknowledgeModeThe acknowledgment mode for the context.
Returns
An IMQContext instance representing the created context.

Implemented in TBTAbstractConnectionFactory.