com.solacesystems.jcsmp.protocol

Interface CSMPChannel

All Known Subinterfaces:

CSMPControllerChannel, CSMPPublisherChannel, CSMPSubscriberChannel

All Known Implementing Classes:

ControllerChannel, TcpChannel, TcpClientChannel

public interface CSMPChannel

CSMPChannel defines the channel control interfaces.

Method Summary

Modifier and Type	Method and Description
void	cleanupBuffers()
void	close() Close the channel (disconnect from the router).
boolean	connected() Check if the channel is connected to the router.
JCSMPChannelProperties	getChannelProperties()
boolean	isAutoReconnector() Checks to see if the underlying channel is an auto-reconnector.
boolean	isUserCloseable()
void	open() Open the channel (connect to the router).

Method Detail

open

void open()
   throws JCSMPException

Open the channel (connect to the router).

Throws:

JCSMPException - on error

close

void close()

Close the channel (disconnect from the router).

cleanupBuffers

void cleanupBuffers()

connected

boolean connected()

Check if the channel is connected to the router.

Returns:

true if the channel is connected to the router

getChannelProperties

JCSMPChannelProperties getChannelProperties()

isAutoReconnector

boolean isAutoReconnector()

Checks to see if the underlying channel is an auto-reconnector. This is a temporary measure applicable to avoid rewriting the pub/sub reconnecting logic at the channel level during the multi-iteration consolidation on client channels. When an auto-reconnector channel delivers an Exception, it means it has already tried (and failed) reconnection tasks, and no further reconnection logic should be executed. If the channel is NOT an auto-reconnector (this method returned false), the Producer or Consumer may perform reconnection logic.

Returns:

true if the channel is an auto-reconnector, false otherwise.

isUserCloseable

boolean isUserCloseable()

Returns:

result