CAConnectionPayload (org.epics.gpclient.ca 1.0.5 API)

java.lang.Object
- org.epics.gpclient.datasource.ca.CAConnectionPayload

```
public class CAConnectionPayload
extends Object
```
Represents the connection payload, which consists of the actual JCA Channel and the CADataSource (which can be used to extract configuration parameters).

Author:

carcassi

Constructor Summary

Constructors
Constructor	Description
`CAConnectionPayload(CAChannelHandler channleHandler, gov.aps.jca.Channel channel, CAConnectionPayload previousPayload)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CADataSource`	`getCADataSource()`	The CADataSource that is using the channel.
`gov.aps.jca.Channel`	`getChannel()`	The JCA channel.
`Instant`	`getEventTime()`	Returns the local time of the connection event.
`gov.aps.jca.dbr.DBRType`	`getFieldType()`
`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.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CAConnectionPayload
```
public CAConnectionPayload(CAChannelHandler channleHandler,
                           gov.aps.jca.Channel channel,
                           CAConnectionPayload previousPayload)
```
- Method Detail
  - getCADataSource
```
public CADataSource getCADataSource()
```
    The CADataSource that is using the channel.
    
    Returns:
    
    the CA data source
  - getChannel
```
public gov.aps.jca.Channel getChannel()
```
    The JCA channel.
    
    Returns:
    
    JCA channel
  - getFieldType
```
public gov.aps.jca.dbr.DBRType getFieldType()
```
  - 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
  - getEventTime
```
public Instant getEventTime()
```
    Returns the local time of the connection event.
    
    Returns:
    
    client connection/disconnection time
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object