NetMauMau  0.24.0
Client API
Classes | Typedefs
Main Classes

Detailed Description

The main classes of NetMauMau.

The AbstractClientVx classes implement each the subset of the protocol up to the given version. They are each subclasses of the previous version. To get access to the latest version refer to the typedef NetMauMau::Client::AbstractClient. An important interface is NetMauMau::Common::ICard which describes a card and provides access to the ranks and suits.

See Utilities for helper functions and macros.
For error handling refer to Exceptions.

Note
All data is transferred as UTF-8 encoded byte strings
This installation of the server enforces the player images to be in the PNG format
This installation of the server uses the GNU Scientific Library for generating random numbers.
See http://www.gnu.org/software/gsl/manual/html_node/Random-number-environment-variables.html or nmm-server(1) for more information.

Classes

class  NetMauMau::Client::AbstractClientV05
 Client interface to communicate with the server More...
class  NetMauMau::Client::AbstractClientV07
 Client interface to communicate with the server More...
class  NetMauMau::Client::AbstractClientV08
 Client interface to communicate with the server More...
class  NetMauMau::Client::AbstractClientV09
 Client interface to communicate with the server More...
class  NetMauMau::Client::AbstractClientV11
 Client interface to communicate with the server More...
class  NetMauMau::Client::AbstractClientV13
 Client interface to communicate with the server More...
interface  NetMauMau::Common::ICard
 Describes a playing card. More...

Typedefs

typedef AbstractClientV13 NetMauMau::Client::AbstractClient
 Alias to the current client interface to communicate with the server.

Typedef Documentation

typedef AbstractClientV13 NetMauMau::Client::AbstractClient

Alias to the current client interface to communicate with the server.

In your client subclass AbstractClient and implement all pure virtual methods. In the constructor AbstractClient you can setup the connection.
To actually join the game you need to call play(). The pure virtual functions are translated events and requests of the server, which your client has to handle accordingly.
If you just want to query the player list, you can call playerList() and to get the servers capabilities you can call capabilities()

A client can be obtained via git: git clone https://github.com/velnias75/NetMauMau-Qt-Client.git

See Also
AbstractClientV13