gov.aps.jca

Class CAStatus

java.lang.Object

gov.aps.jca.Enum

gov.aps.jca.ValuedEnum

gov.aps.jca.CAStatus

public class CAStatus
extends ValuedEnum

Enumeration class representing Channel Access Status codes.

Author:

Eric Boucher

Field Summary

Fields

Modifier and Type	Field and Description
static CAStatus	ADDFAIL Could not perform a database monitor add for that channel.
static CAStatus	ALLOCMEM Unable to allocate additional dynamic memory.
static CAStatus	ANACHRONISM This anachhronistic feature of CA is no longer supported.
static CAStatus	ARRAY16KCLIENT Client's protocol revision does not support transfers exceeding 16k bytes
static CAStatus	BADCHID Invalid channel identifier.
static CAStatus	BADCOUNT Count requested inappropriate for that channel.
static CAStatus	BADFUNCPTR Invalid callback method.
static CAStatus	BADMASK The monitor selection mask supplied is empty or inappropriate.
static CAStatus	BADMONID Bad monitor subscription identifier.
static CAStatus	BADPRIORITY Priority out of range.
static CAStatus	BADSTR The supplied string has improper format.
static CAStatus	BADSYNCGRP Invalid synchronous group identifier.
static CAStatus	BADTYPE The data type specified is invalid.
static CAStatus	BUILDGET Database value get for that channel failed during channel search.
static int	CA_M_ERROR
static int	CA_M_LEVEL
static int	CA_M_MSG_NO
static int	CA_M_SEVERE
static int	CA_M_SEVERITY
static int	CA_M_SUCCESS
static int	CA_S_MSG_NO
static int	CA_S_SEVERITY
static int	CA_V_MSG_NO
static int	CA_V_SEVERITY
static int	CA_V_SUCCESS
static CAStatus	CHANDESTROY User destroyed channel.
static CAStatus	CHIDNOTFND Remote channel not found.
static CAStatus	CHIDRETRY Unable to locate all user specified channels.
static CAStatus	CONN Unable to connect to internet host or service.
static CAStatus	CONNSEQTMO Virtual circuit connection sequence aborted
static CAStatus	DBLCHNL identical process variable name on pultiple servers.
static CAStatus	DBLCLFAIL The requested local DB operation failed.
static CAStatus	DEFUNCT Attempt to use a defunct CA feature failed.
static CAStatus	DISCONN Virtual circuit disconneted.
static CAStatus	DISCONNCHID Request ignored because the specified channel is disconnected.
static CAStatus	DLCKREST Reseting dead connection- will try to reconnect.
static CAStatus	EMPTYSTR The supplied string is empty.
static CAStatus	EVDISALLOW The CA method called is inappropriate for use within an event handler.
static CAStatus	GETFAIL Could not perform a database value get for that channel.
static CAStatus	INTERNAL Channel Access internal failure.
static CAStatus	IODONE IO operations have completed.
static CAStatus	IOINPROGESS IO operations are in progress.
static CAStatus	ISATTACHED Thread is already attached to a client context.
static CAStatus	MAXIOC Maximum simultaneous IOC connections exceed.
static CAStatus	NEEDSFP Unable to initialize without the vxWorks VX_FP_TASK task option set.
static CAStatus	NEWADDR Remote channel has new network address.
static CAStatus	NEWCONN New or resumed network connection.
static CAStatus	NOCACTX Specified task isn't a member of a CA Context.
static CAStatus	NOCAST No internet interface with broadcast available.
static CAStatus	NOCHANMSG No channel id match for search reply- search reply ignored.
static CAStatus	NOCONVERT Data conversion between client's type and the server's type failed.
static CAStatus	NORDACCESS Read access denied.
static CAStatus	NOREPEATER Unable to spawn the CA repeater thread- auto reconnect will fail.
static CAStatus	NORMAL Normal successful completion.
static CAStatus	NOSEARCHADDR The search/beacon request address list was empty after initialization.
static CAStatus	NOSUPPORT Feature planned but not supported at this time.
static CAStatus	NOTTHREADED Preemptive callback not enabled - additional threads may not join.
static CAStatus	NOWTACCESS Write access denied.
static CAStatus	OVEVFAIL Event queue overflow has prevented first pass event after event add.
static CAStatus	PUTCBINPROG Put callback timed out.
static CAStatus	PUTFAIL Could not perform a database value put for that channel.
static CAStatus	SERVBEHIND Server (IOC) has fallen behind or is not responding- still waiting.
static CAStatus	SOCK Unable to allocate a new socket.
static CAStatus	STRTOBIG Supplied string is unusually large.
static CAStatus	TIMEOUT User specified timeout on IO operation expired.
static CAStatus	TOLARGE The requested transfer is greater than available memory or MAX_ARRAY_BYTES.
static CAStatus	UKNCHAN Unknown IO channel.
static CAStatus	UKNFIELD Record field specified inappropriate for channel.
static CAStatus	UKNHOST Unknown internet host.
static CAStatus	UKNSERV Unknown internet service.
static CAStatus	UNAVAILINSERV No supprt in service.
static CAStatus	UNRESPTMO Virtual circuit connection unresponsive

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CAStatus(String name, int value, CASeverity severity, String msg) Creates a new instance of CAStatus

Method Summary

Modifier and Type	Method and Description
static CAStatus	forName(String name)
static CAStatus	forStatusCode(int value) Get status instance from EPICS status code.
static CAStatus	forValue(int value)
String	getMessage()
CASeverity	getSeverity()
int	getStatusCode() Get EPICS status code.
boolean	isError()
boolean	isFatal()
boolean	isSuccessful()
String	toString() Override toString method to produce human readable description.

Methods inherited from class gov.aps.jca.ValuedEnum

getValue, isEqualTo, isGreaterThan, isGreaterThanOrEqual, isLessThan, isLessThanOrEqual

Methods inherited from class gov.aps.jca.Enum

equals, getName, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NORMAL

public static final CAStatus NORMAL

Normal successful completion.

MAXIOC

public static final CAStatus MAXIOC

Maximum simultaneous IOC connections exceed.

UKNHOST

public static final CAStatus UKNHOST

Unknown internet host.

UKNSERV

public static final CAStatus UKNSERV

Unknown internet service.

SOCK

public static final CAStatus SOCK

Unable to allocate a new socket.

CONN

public static final CAStatus CONN

Unable to connect to internet host or service.

ALLOCMEM

public static final CAStatus ALLOCMEM

Unable to allocate additional dynamic memory.

UKNCHAN

public static final CAStatus UKNCHAN

Unknown IO channel.

UKNFIELD

public static final CAStatus UKNFIELD

Record field specified inappropriate for channel.

TOLARGE

public static final CAStatus TOLARGE

The requested transfer is greater than available memory or MAX_ARRAY_BYTES.

TIMEOUT

public static final CAStatus TIMEOUT

User specified timeout on IO operation expired.

NOSUPPORT

public static final CAStatus NOSUPPORT

Feature planned but not supported at this time.

STRTOBIG

public static final CAStatus STRTOBIG

Supplied string is unusually large.

DISCONNCHID

public static final CAStatus DISCONNCHID

Request ignored because the specified channel is disconnected.

BADTYPE

public static final CAStatus BADTYPE

The data type specified is invalid.

CHIDNOTFND

public static final CAStatus CHIDNOTFND

Remote channel not found.

CHIDRETRY

public static final CAStatus CHIDRETRY

Unable to locate all user specified channels.

INTERNAL

public static final CAStatus INTERNAL

Channel Access internal failure.

DBLCLFAIL

public static final CAStatus DBLCLFAIL

The requested local DB operation failed.

GETFAIL

public static final CAStatus GETFAIL

Could not perform a database value get for that channel.

PUTFAIL

public static final CAStatus PUTFAIL

Could not perform a database value put for that channel.

ADDFAIL

public static final CAStatus ADDFAIL

Could not perform a database monitor add for that channel.

BADCOUNT

public static final CAStatus BADCOUNT

Count requested inappropriate for that channel.

BADSTR

public static final CAStatus BADSTR

The supplied string has improper format.

DISCONN

public static final CAStatus DISCONN

Virtual circuit disconneted.

DBLCHNL

public static final CAStatus DBLCHNL

identical process variable name on pultiple servers.

EVDISALLOW

public static final CAStatus EVDISALLOW

The CA method called is inappropriate for use within an event handler.

BUILDGET

public static final CAStatus BUILDGET

Database value get for that channel failed during channel search.

NEEDSFP

public static final CAStatus NEEDSFP

Unable to initialize without the vxWorks VX_FP_TASK task option set.

OVEVFAIL

public static final CAStatus OVEVFAIL

Event queue overflow has prevented first pass event after event add.

BADMONID

public static final CAStatus BADMONID

Bad monitor subscription identifier.

NEWADDR

public static final CAStatus NEWADDR

Remote channel has new network address.

NEWCONN

public static final CAStatus NEWCONN

New or resumed network connection.

NOCACTX

public static final CAStatus NOCACTX

Specified task isn't a member of a CA Context.

DEFUNCT

public static final CAStatus DEFUNCT

Attempt to use a defunct CA feature failed.

EMPTYSTR

public static final CAStatus EMPTYSTR

The supplied string is empty.

NOREPEATER

public static final CAStatus NOREPEATER

Unable to spawn the CA repeater thread- auto reconnect will fail.

NOCHANMSG

public static final CAStatus NOCHANMSG

No channel id match for search reply- search reply ignored.

DLCKREST

public static final CAStatus DLCKREST

Reseting dead connection- will try to reconnect.

SERVBEHIND

public static final CAStatus SERVBEHIND

Server (IOC) has fallen behind or is not responding- still waiting.

NOCAST

public static final CAStatus NOCAST

No internet interface with broadcast available.

BADMASK

public static final CAStatus BADMASK

The monitor selection mask supplied is empty or inappropriate.

IODONE

public static final CAStatus IODONE

IO operations have completed.

IOINPROGESS

public static final CAStatus IOINPROGESS

IO operations are in progress.

BADSYNCGRP

public static final CAStatus BADSYNCGRP

Invalid synchronous group identifier.

PUTCBINPROG

public static final CAStatus PUTCBINPROG

Put callback timed out.

NORDACCESS

public static final CAStatus NORDACCESS

Read access denied.

NOWTACCESS

public static final CAStatus NOWTACCESS

Write access denied.

ANACHRONISM

public static final CAStatus ANACHRONISM

This anachhronistic feature of CA is no longer supported.

NOSEARCHADDR

public static final CAStatus NOSEARCHADDR

The search/beacon request address list was empty after initialization.

NOCONVERT

public static final CAStatus NOCONVERT

Data conversion between client's type and the server's type failed.

BADCHID

public static final CAStatus BADCHID

Invalid channel identifier.

BADFUNCPTR

public static final CAStatus BADFUNCPTR

Invalid callback method.

ISATTACHED

public static final CAStatus ISATTACHED

Thread is already attached to a client context.

UNAVAILINSERV

public static final CAStatus UNAVAILINSERV

No supprt in service.

CHANDESTROY

public static final CAStatus CHANDESTROY

User destroyed channel.

BADPRIORITY

public static final CAStatus BADPRIORITY

Priority out of range.

NOTTHREADED

public static final CAStatus NOTTHREADED

Preemptive callback not enabled - additional threads may not join.

ARRAY16KCLIENT

public static final CAStatus ARRAY16KCLIENT

Client's protocol revision does not support transfers exceeding 16k bytes

CONNSEQTMO

public static final CAStatus CONNSEQTMO

Virtual circuit connection sequence aborted

UNRESPTMO

public static final CAStatus UNRESPTMO

Virtual circuit connection unresponsive

CA_M_MSG_NO

public static final int CA_M_MSG_NO

See Also:

Constant Field Values

CA_M_SEVERITY

public static final int CA_M_SEVERITY

See Also:

Constant Field Values

CA_M_LEVEL

public static final int CA_M_LEVEL

See Also:

Constant Field Values

CA_M_SUCCESS

public static final int CA_M_SUCCESS

See Also:

Constant Field Values

CA_M_ERROR

public static final int CA_M_ERROR

See Also:

Constant Field Values

CA_M_SEVERE

public static final int CA_M_SEVERE

See Also:

Constant Field Values

CA_S_MSG_NO

public static final int CA_S_MSG_NO

See Also:

Constant Field Values

CA_S_SEVERITY

public static final int CA_S_SEVERITY

See Also:

Constant Field Values

CA_V_MSG_NO

public static final int CA_V_MSG_NO

See Also:

Constant Field Values

CA_V_SEVERITY

public static final int CA_V_SEVERITY

See Also:

Constant Field Values

CA_V_SUCCESS

public static final int CA_V_SUCCESS

See Also:

Constant Field Values

Constructor Detail

CAStatus

protected CAStatus(String name,
                   int value,
                   CASeverity severity,
                   String msg)

Creates a new instance of CAStatus

Method Detail

isSuccessful

public boolean isSuccessful()

isError

public boolean isError()

isFatal

public boolean isFatal()

getSeverity

public CASeverity getSeverity()

getMessage

public String getMessage()

toString

public String toString()

Description copied from class: ValuedEnum

Override toString method to produce human readable description.

Overrides:

toString in class ValuedEnum

Returns:

String in the form type[name=value], eg.: JavaVersion[Java 1.0=100].

forName

public static CAStatus forName(String name)

forValue

public static final CAStatus forValue(int value)

getStatusCode

public final int getStatusCode()

Get EPICS status code.

Returns:

EPICS status code.

forStatusCode

public static final CAStatus forStatusCode(int value)

Get status instance from EPICS status code.

Parameters:

value - EPICS status code.

Returns:

status instance from EPICS status code.