org.epics.ca.impl

Class ChannelImpl<T>

java.lang.Object

org.epics.ca.impl.ChannelImpl<T>

All Implemented Interfaces:

java.lang.AutoCloseable, Channel<T>, TransportClient

public class ChannelImpl<T>
extends java.lang.Object
implements Channel<T>, TransportClient

Constructor Summary

Constructors

Constructor and Description
ChannelImpl(ContextImpl context, java.lang.String name, java.lang.Class<T> channelType, int priority)

Method Summary

Modifier and Type	Method and Description
Listener	addAccessRightListener(java.util.function.BiConsumer<Channel<T>,AccessRights> handler)
Listener	addConnectionListener(java.util.function.BiConsumer<Channel<T>,java.lang.Boolean> handler)
<MT extends Metadata<T>> Monitor<MT>	addMonitor(java.lang.Class<? extends Metadata> clazz, java.util.function.Consumer<MT> handler, int mask)
Monitor<T>	addValueMonitor(java.util.function.Consumer<? super T> handler, int mask)
void	close()
Channel<T>	connect()
java.util.concurrent.CompletableFuture<Channel<T>>	connectAsync()
void	createChannel(TcpTransport transport, int sid, short typeCode, int elementCount) Create a channel, i.e.
void	disconnect(boolean reconnect)
boolean	generateSearchRequestMessage(Transport transport, java.nio.ByteBuffer buffer) Send search message.
T	get()
<MT extends Metadata<T>> MT	get(java.lang.Class<? extends Metadata> clazz)
AccessRights	getAccessRights()
java.util.concurrent.CompletableFuture<T>	getAsync()
<MT extends Metadata<T>> java.util.concurrent.CompletableFuture<MT>	getAsync(java.lang.Class<? extends Metadata> clazz)
int	getCID()
ConnectionState	getConnectionState()
java.lang.String	getName()
int	getNativeElementCount()
java.util.Map<java.lang.String,java.lang.Object>	getProperties()
int	getSID()
TcpTransport	getTcpTransport()
java.lang.Object	getTimerId()
void	put(T value)
java.util.concurrent.CompletableFuture<Status>	putAsync(T value)
void	putNoWait(T value)
void	registerResponseRequest(ResponseRequest responseRequest) Register a response request.
void	setAccessRights(AccessRights rights)
void	setTimerId(java.lang.Object timerId)
void	transportClosed() Notification of forcefully closed transport.
void	unregisterResponseRequest(ResponseRequest responseRequest) Unregister a response request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.epics.ca.Channel

addMonitor, addValueMonitor

Constructor Detail

ChannelImpl

public ChannelImpl(ContextImpl context,
                   java.lang.String name,
                   java.lang.Class<T> channelType,
                   int priority)

Method Detail

transportClosed

public void transportClosed()

Description copied from interface: TransportClient

Notification of forcefully closed transport.

Specified by:

transportClosed in interface TransportClient

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface Channel<T>

getName

public java.lang.String getName()

Specified by:

getName in interface Channel<T>

getConnectionState

public ConnectionState getConnectionState()

Specified by:

getConnectionState in interface Channel<T>

getAccessRights

public AccessRights getAccessRights()

Specified by:

getAccessRights in interface Channel<T>

connectAsync

public java.util.concurrent.CompletableFuture<Channel<T>> connectAsync()

Specified by:

connectAsync in interface Channel<T>

connect

public Channel<T> connect()

Specified by:

connect in interface Channel<T>

addConnectionListener

public Listener addConnectionListener(java.util.function.BiConsumer<Channel<T>,java.lang.Boolean> handler)

Specified by:

addConnectionListener in interface Channel<T>

addAccessRightListener

public Listener addAccessRightListener(java.util.function.BiConsumer<Channel<T>,AccessRights> handler)

Specified by:

addAccessRightListener in interface Channel<T>

get

public T get()

Specified by:

get in interface Channel<T>

put

public void put(T value)

Specified by:

put in interface Channel<T>

putNoWait

public void putNoWait(T value)

Specified by:

putNoWait in interface Channel<T>

getAsync

public java.util.concurrent.CompletableFuture<T> getAsync()

Specified by:

getAsync in interface Channel<T>

putAsync

public java.util.concurrent.CompletableFuture<Status> putAsync(T value)

Specified by:

putAsync in interface Channel<T>

get

public <MT extends Metadata<T>> MT get(java.lang.Class<? extends Metadata> clazz)

Specified by:

get in interface Channel<T>

getAsync

public <MT extends Metadata<T>> java.util.concurrent.CompletableFuture<MT> getAsync(java.lang.Class<? extends Metadata> clazz)

Specified by:

getAsync in interface Channel<T>

addValueMonitor

public Monitor<T> addValueMonitor(java.util.function.Consumer<? super T> handler,
                                  int mask)

Specified by:

addValueMonitor in interface Channel<T>

addMonitor

public <MT extends Metadata<T>> Monitor<MT> addMonitor(java.lang.Class<? extends Metadata> clazz,
                                                       java.util.function.Consumer<MT> handler,
                                                       int mask)

Specified by:

addMonitor in interface Channel<T>

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

Specified by:

getProperties in interface Channel<T>

generateSearchRequestMessage

public boolean generateSearchRequestMessage(Transport transport,
                                            java.nio.ByteBuffer buffer)

Send search message.

Parameters:

transport - the transport.

buffer - the buffer to send.

Returns:

success status.

getTcpTransport

public TcpTransport getTcpTransport()

getNativeElementCount

public int getNativeElementCount()

registerResponseRequest

public void registerResponseRequest(ResponseRequest responseRequest)

Register a response request.

Parameters:

responseRequest - response request to register.

unregisterResponseRequest

public void unregisterResponseRequest(ResponseRequest responseRequest)

Unregister a response request.

Parameters:

responseRequest - response request to unregister.

getCID

public int getCID()

getSID

public int getSID()

setAccessRights

public void setAccessRights(AccessRights rights)

setTimerId

public void setTimerId(java.lang.Object timerId)

getTimerId

public java.lang.Object getTimerId()

createChannel

public void createChannel(TcpTransport transport,
                          int sid,
                          short typeCode,
                          int elementCount)

Create a channel, i.e. submit create channel request to the server. This method is called after search is complete. sid, typeCode, elementCount might not be valid, this depends on protocol revision.

Parameters:

transport - the transport.

sid - the CA server ID.

typeCode - the CA DBR typecode.

elementCount - the number of elements to be associated with each CA get/put/monitor operation.

disconnect

public void disconnect(boolean reconnect)