Fonctions membres publiques | Fonctions membres publiques statiques

# Référence de la classe USpeedGameEngine::Network::Client

Classe client TCP/IP. Plus de détails...

Liste de tous les membres

## Fonctions membres publiques

| Client ()
| Constructeur par défaut.
| ~Client ()
| Destructeur par défaut.
bool | start (const char *url)
| Démarrage du client.
bool | start (const char *serverIP, unsigned int port)
| Démarrage du client.
bool | process (std::string *targetBuffer)
| Le traitement régulier du client en cours d'exécution pour lire le SOCKET.
bool | sendTo (std::string const &dataToSend)
| Envoie de données du client au serveur.
void | stop ()
| Arrête le serveur, le thread de connexion et les threads d'écoute.
bool | isRunning ()
| Permet de savoir si le socket du client est valide et en écoute.

## Fonctions membres publiques statiques

static void | httpContent (std::string const &url, std::string &response, std::string const &header, std::string const &postData, unsigned long int timeout)
| Récupération du contenu de l'URL spécifiée en HTTP.

## Description détaillée

Classe client TCP/IP.

Auteur:
  U.Speed

## Documentation des constructeurs et destructeur

Network::Client::Client | ( |  | ) |

Constructeur par défaut.

Auteur:
  U.Speed

Network::Client::~Client | ( |  | ) |

Destructeur par défaut.

Auteur:
  U.Speed

## Documentation des fonctions membres

void Network::Client::httpContent | ( | std::string const & | url,
|  | std::string & | response,
|  | std::string const & | header,
|  | std::string const & | postData,
|  | unsigned long int | timeout |
| ) |  |  | `[static]`

Récupération du contenu de l'URL spécifiée en HTTP.

Auteur:
  U.Speed

Paramètres:

  | url | std::string const& : l'adresse internet de la ressource (ex: "http://www.server.com/mypage.html" ou "server.com:8080/myfile.ext")
  | response | std::string& : la cible pour la réponse reçue du serveur (vide si rien n'a été reçu).
  | header | std::string const& : des données à ajouter dans l'entête HTTP (ex: "Cookie: a54e54f6587\r\n")
  | postData | std::string const& : les données à passer en "POST" au serveur.
  | timeout | unisgned long int : délai d'expiration du traitement de la requête si aucune donnée n'est reçue (en millisecondes). "0" pour infini.

bool Network::Client::isRunning | ( |  | ) |

Permet de savoir si le socket du client est valide et en écoute.

Auteur:
  U.Speed

Renvoie:
  bool : `true` si le client est en cours d'exécution avec un socket valide

bool Network::Client::process | ( | std::string * | targetBuffer | ) |

Le traitement régulier du client en cours d'exécution pour lire le SOCKET.

Auteur:
  U.Speed

Paramètres:

  | targetBuffer | std::string* : le tampon qui va accueillir les données éventuellement reçues

Renvoie:
  bool : `true` si on a reçu de nouvelles données

bool Network::Client::sendTo | ( | std::string const & | dataToSend | ) |

Envoie de données du client au serveur.

Auteur:
  U.Speed

Paramètres:

  | dataToSend | std::string const& : les données à envoyer

Renvoie:
  bool : `true` si les données ont été envoyées

bool Network::Client::start | ( | const char * | url | ) |

Démarrage du client.

Auteur:
  U.Speed

Paramètres:

  | url | const char* : l'adresse internet du serveur (exemples : "www.uspeed.fr", "service.uspeed.fr:8080")

Renvoie:
  bool : l'état de la connexion

bool Network::Client::start | ( | const char * | serverIP,
|  | unsigned int | port |
| ) |  |  |

Démarrage du client.

Auteur:
  U.Speed

Paramètres:

  | serverIP | const char* : l'IP du serveur
  | port | const char* : le port du serveur

Renvoie:
  bool : l'état de la connexion

void Network::Client::stop | ( |  | ) |

Arrête le serveur, le thread de connexion et les threads d'écoute.

Auteur:
  U.Speed

La documentation de cette classe a été générée à partir des fichiers suivants :

- src/Network/Client.hpp
- src/Network/Client.cpp
- src/Network/Client_httpContent.cpp
- src/Network/Client_isRunning.cpp
- src/Network/Client_process.cpp
- src/Network/Client_sendTo.cpp
- src/Network/Client_start.cpp
- src/Network/Client_stop.cpp