ECS_AnnoRequest

- an annotation request

SYNOPSIS

#include <ECS/AnnoRequest.hh>
class ECS_AnnoRequest
{
	public:
	_ECSAIO_PRIVAPI ECS_AnnoRequest(ECS_AnnoRequest const& other);
	_ECSAIO_PRIVAPI ECS_AnnoRequest const& operator=
	   ( ECS_AnnoRequest const& other);
	_ECSAIO_PRIVAPI virtual ~ECS_AnnoRequest();
	virtual ostream& print(ostream& os) const;
	_ECSAIO_PRIVAPI ECS_AnnoData getData() const;
	_ECSAIO_PRIVAPI const char* getCircuitName() const;
	_ECSAIO_PRIVAPI const char* getAnnoNodeName() const;
	_ECSAIO_PRIVAPI int32 getSequenceNumber() const;
	_ECSAIO_PRIVAPI int32 getExpiryTime() const;
	_ECSAIO_PRIVAPI bool hasBeenRespondedTo() const;
	_ECSAIO_PRIVAPI int32 respond(const ECS_AnnoData& responseData);
	_ECSAIO_PRIVAPI int32 reject();
};

CLASS TYPE

Concrete

AUDIENCE

ECS Application developers

DESCRIPTION

This class is effectively a message which encapsulates an annotation request from the engine.

The class contains an instance of the class ECS_AnnoData, which contains the list of data resulting from the evaluation of the annotate spec of the annotate node issuing the request.

The request also contains other information such as the name of the circuit and annotation node which issued the request and the sequence number and expiry time of the request.

Constructors and Destructors

_ECSAIO_PRIVAPI ECS_AnnoRequest(ECS_AnnoRequest const& other);

The copy constructor

_ECSAIO_PRIVAPI ECS_AnnoRequest const& operator=
( ECS_AnnoRequest const& other);

The assignment operator

_ECSAIO_PRIVAPI virtual ~ECS_AnnoRequest();

The destructor

Utility

virtual ostream& print(ostream& os) const;

Prints a textual representation of the class to the output stream specified via os.

_ECSAIO_PRIVAPI ECS_AnnoData getData() const;

Returns a pointer to the request data included in this request.

_ECSAIO_PRIVAPI const char* getCircuitName() const;

Returns the name of the circuit from which the annotation request was issued. Returns 0 if there is difficulty accessing the supplementary request information.

_ECSAIO_PRIVAPI const char* getAnnoNodeName() const;

Returns the name of the annotation node from which the annotation request was issued.

_ECSAIO_PRIVAPI int32 getSequenceNumber() const;

Extract the sequence number of the annotation request.

Returns the sequence number or -1 if the sequence number could not be determined.

_ECSAIO_PRIVAPI int32 getExpiryTime() const;

Returns the expiry time of the annotation request in seconds since the epoch.

_ECSAIO_PRIVAPI bool hasBeenRespondedTo() const;

Returns TRUE if the annotation request has been responded to; returns FALSE otherwise.

Note: If there is a problem with this request, this method will return TRUE. This is to indicate that a response is not required. This should not occur except in an out-of-memory condition.

_ECSAIO_PRIVAPI int32 respond(const ECS_AnnoData& responseData);

Send a response to the annotation request. This can only be done once per request. The method hasBeenRespondedTo()can be used to determine if a response has already been sent.

_ECSAIO_PRIVAPI int32 reject();

Reject the annotation request and free internal data structures associated with the request

NOTES

None

SEE ALSO

ECS_Annotater

LIBRARY

ECS

VERSION

1.3

DATE RELEASED

1998/02/25

AUTHOR(S)

Hewlett-Packard Company

COPYRIGHT

Copyright (c) 1997 Hewlett-Packard Company. All Rights Reserved.