org.epics.pvmanager.jca

Class JCAConnectionPayload

java.lang.Object

org.epics.pvmanager.jca.JCAConnectionPayload

public class JCAConnectionPayload
extends Object

Represents the connection payload, which consists of the actual JCA Channel and the JCADataSource (which can be used to extract configuration parameters).

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
JCAConnectionPayload(org.epics.pvmanager.jca.JCAChannelHandler channleHandler, gov.aps.jca.Channel channel)

Method Summary

Methods

Modifier and Type	Method and Description
gov.aps.jca.Channel	getChannel() The JCA channel.
JCADataSource	getJcaDataSource() The JCADataSource that is using the channel.
boolean	isChannelConnected() True if the channel is not null and the connection state is connected.
boolean	isLongString() Whether the message payload should be handled as a long string.
boolean	isWriteConnected() True if the channel is not null, connected, and can be written to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JCAConnectionPayload

public JCAConnectionPayload(org.epics.pvmanager.jca.JCAChannelHandler channleHandler,
                    gov.aps.jca.Channel channel)

Method Detail

getJcaDataSource

public JCADataSource getJcaDataSource()

The JCADataSource that is using the channel.

Returns:

the JCA data source

getChannel

public gov.aps.jca.Channel getChannel()

The JCA channel.

Returns:

JCA channel

isChannelConnected

public boolean isChannelConnected()

True if the channel is not null and the connection state is connected.

Returns:

ture if channel exists and is connected

isWriteConnected

public boolean isWriteConnected()

True if the channel is not null, connected, and can be written to.

Returns:

true if the channel is ready for write

isLongString

public boolean isLongString()

Whether the message payload should be handled as a long string.

Returns:

true if long string support should be used