mirror of
https://github.com/RetroShare/RetroShare.git
synced 2025-08-22 20:59:45 -04:00
100 lines
3.4 KiB
C++
100 lines
3.4 KiB
C++
/*******************************************************************************
|
|
* libretroshare/src/retroshare: rsstatus.h *
|
|
* *
|
|
* libretroshare: retroshare core library *
|
|
* *
|
|
* Copyright 2007-2008 by Vinny Do, Chris Evi-Parker *
|
|
* *
|
|
* This program is free software: you can redistribute it and/or modify *
|
|
* it under the terms of the GNU Lesser General Public License as *
|
|
* published by the Free Software Foundation, either version 3 of the *
|
|
* License, or (at your option) any later version. *
|
|
* *
|
|
* This program is distributed in the hope that it will be useful, *
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
|
|
* GNU Lesser General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU Lesser General Public License *
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>. *
|
|
* *
|
|
*******************************************************************************/
|
|
#ifndef RS_STATUS_INTERFACE_H
|
|
#define RS_STATUS_INTERFACE_H
|
|
|
|
class RsStatus;
|
|
|
|
extern RsStatus *rsStatus;
|
|
|
|
#include <iostream>
|
|
#include <string>
|
|
#include <inttypes.h>
|
|
#include <list>
|
|
#include <retroshare/rstypes.h>
|
|
|
|
|
|
const uint32_t RS_STATUS_OFFLINE = 0x0000;
|
|
const uint32_t RS_STATUS_AWAY = 0x0001;
|
|
const uint32_t RS_STATUS_BUSY = 0x0002;
|
|
const uint32_t RS_STATUS_ONLINE = 0x0003;
|
|
const uint32_t RS_STATUS_INACTIVE = 0x0004;
|
|
|
|
const uint32_t RS_STATUS_COUNT = 0x0005; // count of status
|
|
|
|
//! data object for peer status information
|
|
/*!
|
|
* data object used for peer status information
|
|
*/
|
|
class StatusInfo
|
|
{
|
|
public:
|
|
StatusInfo()
|
|
{
|
|
status = 0;
|
|
time_stamp = 0;
|
|
}
|
|
|
|
public:
|
|
RsPeerId id;
|
|
uint32_t status;
|
|
time_t time_stamp; /// for owner time set, and for their peers time sent
|
|
};
|
|
|
|
|
|
//! Interface to retroshare for Rs status
|
|
/*!
|
|
* Provides an interface for retroshare's status functionality
|
|
*/
|
|
class RsStatus
|
|
{
|
|
public:
|
|
|
|
/**
|
|
* This retrieves the own status info
|
|
* @param statusInfo is populated with own status
|
|
*/
|
|
virtual bool getOwnStatus(StatusInfo& statusInfo) = 0;
|
|
|
|
/**
|
|
* This retrieves the status info on the client's peers
|
|
* @param statusInfo is populated with client's peer's status
|
|
*/
|
|
virtual bool getStatusList(std::list<StatusInfo>& statusInfo) = 0;
|
|
|
|
/**
|
|
* This retrieves the status info one peer
|
|
* @param statusInfo is populated with client's peer's status
|
|
*/
|
|
virtual bool getStatus(const RsPeerId &id, StatusInfo &statusInfo) = 0;
|
|
|
|
/**
|
|
* send the client's status to his/her peers
|
|
* @param id the peer to send the status (empty, send to all)
|
|
* @param status the status of the peers
|
|
* @return will return false if status info does not belong to client
|
|
*/
|
|
virtual bool sendStatus(const RsPeerId &id, uint32_t status) = 0;
|
|
};
|
|
|
|
|
|
#endif
|