BMessageRunner

Héritée de : (aucune)
Déclarée dans :  be/app/MessageRunner.h
Bibliothèque : libbe.so
Allocation : Constructeur uniquement
Résumé :  plus...

La Classe BMessageRunner fournit un mécanisme pratique pour envoyer automatiquement un message arbitraire à un BMessenger, à des intervalles spécifiés. L'application qui crée le BMessageRunner peut spécifier le message, le BMessenger à qui envoyer le message, la fréquence d'envoi du message et le nombre de fois qu'il doit être envoyé.

En fait, c'est la liste système (roster) qui gère la distribution des messages aux BMessengers concernés, aux intervalles de temps désirés ; cette classe agit simplement en tant qu'intermédiaire par lequel votre application demande au roster de planifier l'envoi des messages.

Constructeur et Destructeur

BMessageRunner()

BMessageRunner(BMessenger target, const BMessage *message,       bigtime_t interval, int32 count = -1) BMessageRunner(BMessenger target, const BMessage *message,       bigtime_t interval, int32 count, BMessenger replyTo)

Dit au roster d'envoyer le message spécifié au BMessenger target toutes les interval microsecondes. Le message sera envoyé count fois (si count vaut -1, le message sera envoyé sans fin, ou jusqu'à ce que BMessageRunner soit reconfiguré ou détruit).

La seconde forme du constructeur laisse l'application spécifier, dans replyTo, le BMessenger auquel les réponses au message doivent être envoyées.

BMessageRunner peut être reconfiguré (pour modifier interval ou count) en appelant SetInterval() et SetCount().

Après avoir construit un BMessageRunner, vous devriez appeler InitCheck() pour être certain que l'objet a été créé correctement.

~BMessageRunner()

virtual ~BMessageRunner()

Demande au roster de cesser d'envoyer le message.

Fonctions Membre

GetInfo()

status_t GetInfo(bigtime_t *interval, int32 *count) const

GetInfo() renvoie dans interval la durée en microsecondes qui s'écoulera entre l'envoi des messages, et dans count le nombre d'envois du message.

CODES RETOUR

• B_OK. Information renvoyée avec succès.

• B_NAME_NOT_FOUND. Le roster a retourné une information invalide concernant le BMessenger.

• B_BAD_VALUE. Le roster a retourné une information invalide concernant le BMessenger.

• Autres erreurs. En général, obtenir une erreur au retour de cette fonction est une mauvaise chose.

InitCheck()

status_t InitCheck(void) const

InitCheck() renvoie un code indiquant B_OK si le constructeur BMessageRunner a réussi, ou une autre valeur si une erreur s'est produite durant la construction de l'objet. Vous devriez l'appeler immédiatement après la création d'un BMessageRunner, et ne pas utiliser l'objet si cette fonction renvoie autre chose que B_OK.

SetCount() , SetInterval()

status_t SetCount(int32 count) status_t SetInterval(bigtime_t interval)

SetCount() configure le nombre de fois que le BMessageRunner enverra le message. Si vous voulez que le message soit envoyé sans fin (jusqu'à ce que l'objet soit détruit ou que SetCount() soit appelée à nouveau), spécifier -1.

SetInterval() configure le nombre de microsecondes qui s'écoulera entre l'envoi des messages.