Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

An Overview of the Client Class

Each Glish client constructs one instance of the Client class by passing the Client constructor the program's argc and argv. When a Glish client is executed by a Glish script argv contains special arguments telling the Client object how to connect the Glish interpreter. So usually the beginning of a Glish client looks like:

    int main( int argc, char** argv )
        {
        Client c( argc, argv );
        ...

The Client constructor removes these special arguments from argv (and correspondingly updates argc) so after the Client object is constructed the program no longer ``sees" the arguments.

The Client class provides four main member functions:

• NextEvent waits for the next event to arrive and returns its name and a corresponding Value object. The event is returned as a pointer to a GlishEvent object. (See § 15.3, page , below.)

• PostEvent takes a string and a Value object and sends an event with the given name and value.

• Reply replies to the most recently-received request/reply event with a Value object. (See § 7.4, page ).
• ReplyPending indicates if the most recent event has a reply pending. (See § 7.4, page .)

• Error posts an ``error'' event.

• Unrecognized is used to report that the current event is not recognized by the Glish client.

The class also provides variants on PostEvent for sending events with simple string values. (See § 15.5, page , below, for details.) In addition, the class provides access to the file descriptors from which it reads events, so the program can use select() to multiplex between different input sources (see § 15.5.2, page ).