org.rvpf.pap.cip

Class CIPClient

Object

PAPClient.Abstract

CIPClient

All Implemented Interfaces:

PAPClient, PAPConnectionListener

public class CIPClient
extends PAPClient.Abstract

Client.

Nested Class Summary

Nested classes/interfaces inherited from interface PAPClient

PAPClient.Abstract

Nested classes/interfaces inherited from interface PAPConnectionListener

PAPConnectionListener.Manager

Constructor Summary

Constructors

Constructor and Description
CIPClient(CIPClientContext clientContext) Constructs an instance

Method Summary

Modifier and Type	Method and Description
void	close() Closes this client.
Collection<WriteTransaction.Response>	commitPointUpdateRequests() Commits point update requests.
Collection<ReadTransaction.Response>	commitPointValueRequests() Commits point value requests.
boolean	connect(Origin origin) Connects to a server.
void	disconnect(Origin origin) Disconnects from a server.
PointValue[]	fetchPointValues(Point[] points) Fetches point values.
void	open() Opens.
Optional<WriteTransaction.Request>	requestPointUpdate(PointValue pointValue) Requests a point update.
Optional<ReadTransaction.Request>	requestPointValue(Point point) Requests a point value.
void	rollbackReadRequests() Rolls back read requests.
void	rollbackWriteRequests() Rolls back write requests.
Exception[]	updatePointValues(PointValue[] pointValues) Updates point values.

Methods inherited from class PAPClient.Abstract

addConnectionListener, disconnect, forgetServerProxy, forgetServerProxy, getContext, getKnownServerProxies, getOrigin, getPointProxy, getServerProxy, getThisLogger, isPointActive, onLostConnection, onNewConnection, removeConnectionListener

Methods inherited from class Object

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

Constructor Detail

CIPClient

public CIPClient(@Nonnull
                 CIPClientContext clientContext)

Constructs an instance

Parameters:

clientContext - The CIP client context.

Method Detail

close

public void close()

Closes this client.

Specified by:

close in interface PAPClient

Overrides:

close in class PAPClient.Abstract

commitPointUpdateRequests

@Nonnull
 @CheckReturnValue
public Collection<WriteTransaction.Response> commitPointUpdateRequests()
                                                                                              throws ServiceNotAvailableException

Commits point update requests.

Returns:

The responses.

Throws:

ServiceNotAvailableException - On connection failure.

commitPointValueRequests

@Nonnull
 @CheckReturnValue
public Collection<ReadTransaction.Response> commitPointValueRequests()
                                                                                            throws ServiceNotAvailableException

Commits point value requests.

Returns:

The responses.

Throws:

ServiceNotAvailableException - On connection failure.

connect

public boolean connect(Origin origin)

Connects to a server.

Parameters:

origin - The origin representing the server.

Returns:

True on success.

disconnect

public void disconnect(Origin origin)

Disconnects from a server.

Parameters:

origin - The origin representing the server.

fetchPointValues

public PointValue[] fetchPointValues(Point[] points)
                              throws InterruptedException,
                                     ServiceNotAvailableException

Fetches point values.

Parameters:

points - The points.

Returns:

The point values.

Throws:

InterruptedException - When interrupted.

ServiceNotAvailableException - On service not available.

open

public void open()

Opens.

requestPointUpdate

@Nonnull
 @CheckReturnValue
public Optional<WriteTransaction.Request> requestPointUpdate(@Nonnull
                                                                                           PointValue pointValue)

Requests a point update.

Parameters:

pointValue - The point value.

Returns:

The optional new request.

requestPointValue

@Nonnull
 @CheckReturnValue
public Optional<ReadTransaction.Request> requestPointValue(@Nonnull
                                                                                         Point point)

Requests a point value.

Parameters:

point - The point.

Returns:

The optional new request.

rollbackReadRequests

public void rollbackReadRequests()

Rolls back read requests.

rollbackWriteRequests

public void rollbackWriteRequests()

Rolls back write requests.

updatePointValues

public Exception[] updatePointValues(PointValue[] pointValues)
                              throws ServiceNotAvailableException

Updates point values.

Parameters:

pointValues - The point values.

Returns:

An exception array.

Throws:

ServiceNotAvailableException - On service not available.