Connected Property

Triggers a connection or disconnection.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int GetConnected();
int SetConnected(int bConnected);

Unicode (Windows)
BOOL GetConnected();
INT SetConnected(BOOL bConnected);

@property (nonatomic,readwrite,assign,getter=connected,setter=setConnected:) BOOL connected;
- (BOOL)connected;
- (void)setConnected:(BOOL)newConnected;

#define PID_STOMP_CONNECTED 1

IPWORKSIOT_EXTERNAL void* IPWORKSIOT_CALL IPWorksIoT_STOMP_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSIOT_EXTERNAL int IPWORKSIOT_CALL IPWorksIoT_STOMP_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

FALSE

Remarks

This property triggers a connection or disconnection. Setting this property to True makes the class attempt to connect to the host identified by the RemoteHost property. If successful, after the connection is achieved the value of the property changes to True and the Connected event is fired.

Setting this property to False closes the connection.

When connecting to a STOMP server, the class sends information from the following properties, if populated:

• IncomingHeartbeat
• OutgoingHeartbeat
• User
• Password

In addition to the above properties, the following configuration settings can be set before connecting (though in most cases this is not necessary):

• SupportedVersions: Controls which STOMP versions the class advertises support for.
• VirtualHost: Controls the virtual host to connect to. If left empty (default), the value from RemoteHost is used.

This property is not available at design time.

Data Type

Boolean