|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
See:
Description
| Packages | |
|---|---|
| edu.csus.ecs.pc2.api | PC2 API. |
| edu.csus.ecs.pc2.api.exceptions | PC2 API exceptions. |
| edu.csus.ecs.pc2.api.listener | PC2 API Listeners and Listener events. |
This documentation describes the current draft of the PC2 API, which is subject to change.
The API package provides the facilities necessary for user-written Client applications to directly access a PC2 Server. The API would typically be used by those wishing to write their own custom Clients; for example, specialized Team, Judge, or Scoreboard modules. Utilizing the facilities of the API package, such user-written modules can gain access to a wide variety of contest data for the contest being run by the targeted PC2 Server.
NOTE: while anyone can write a custom client module to access a PC2 Server, the ability to actually connect such a module to a Server is enforced at the Server side. In order for a Client to login to a Server and access its services, the Client must provide authentication credentials in the form of a login account and password which has been created on the Server by the Contest Administrator. In addition, access provided to such a logged-in client is limited to the privileges granted by the Contest Administrator to that account.
Using the facilities in the API package requires that a PC2 Server already be running, and that the custom Client making use of the API be provided with a pc2v9.ini file just as with any other PC2 client. The API package documentation assumes the reader is already familiar with these concepts; see the separate PC2 Contest Administrator's Guide for additional details.
Writing a custom Client using the PC2 API involves three basic steps:
IContest, a representation of the
contest being controlled by the server.
IContest methods to access server operations and obtain contest data.
|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||