// // Assignment.h // hifi // // Created by Stephen Birarda on 8/22/13. // Copyright (c) 2013 HighFidelity, Inc. All rights reserved. // #ifndef __hifi__Assignment__ #define __hifi__Assignment__ #include #include #include "NodeList.h" const int NUM_BYTES_RFC4122_UUID = 16; /// Holds information used for request, creation, and deployment of assignments class Assignment : public QObject { Q_OBJECT public: enum Type { AudioMixerType, AvatarMixerType, AgentType, VoxelServerType, AllTypes }; enum Command { CreateCommand, DeployCommand, RequestCommand }; enum Location { GlobalLocation, LocalLocation }; Assignment(Assignment::Command command, Assignment::Type type, Assignment::Location location = Assignment::GlobalLocation); /// Constructs an Assignment from the data in the buffer /// \param dataBuffer the source buffer to un-pack the assignment from /// \param numBytes the number of bytes left to read in the source buffer Assignment(const unsigned char* dataBuffer, int numBytes); ~Assignment(); const QUuid& getUUID() const { return _uuid; } QString getUUIDStringWithoutCurlyBraces() const; Assignment::Command getCommand() const { return _command; } Assignment::Type getType() const { return _type; } Assignment::Location getLocation() const { return _location; } const timeval& getTime() const { return _time; } uchar* getPayload() { return _payload; } int getNumPayloadBytes() const { return _numPayloadBytes; } void setPayload(uchar *payload, int numBytes); int getNumberOfInstances() const { return _numberOfInstances; } void setNumberOfInstances(int numberOfInstances) { _numberOfInstances = numberOfInstances; } void decrementNumberOfInstances() { --_numberOfInstances; } const sockaddr* getAttachedPublicSocket() { return _attachedPublicSocket; } void setAttachedPublicSocket(const sockaddr* attachedPublicSocket); const sockaddr* getAttachedLocalSocket() { return _attachedLocalSocket; } void setAttachedLocalSocket(const sockaddr* attachedLocalSocket); /// Packs the assignment to the passed buffer /// \param buffer the buffer in which to pack the assignment /// \return number of bytes packed into buffer int packToBuffer(unsigned char* buffer); /// Sets _time to the current time given by gettimeofday void setCreateTimeToNow() { gettimeofday(&_time, NULL); } /// blocking run of the assignment virtual void run(); private: QUuid _uuid; /// the 16 byte UUID for this assignment Assignment::Command _command; /// the command for this assignment (Create, Deploy, Request) Assignment::Type _type; /// the type of the assignment, defines what the assignee will do Assignment::Location _location; /// the location of the assignment, allows a domain to preferentially use local ACs sockaddr* _attachedPublicSocket; /// pointer to a public socket that relates to assignment, depends on direction sockaddr* _attachedLocalSocket; /// pointer to a local socket that relates to assignment, depends on direction timeval _time; /// time the assignment was created (set in constructor) int _numberOfInstances; /// the number of instances of this assignment uchar *_payload; /// an optional payload attached to this assignment, a maximum for 1024 bytes will be packed int _numPayloadBytes; /// number of bytes in the payload, up to a maximum of 1024 }; QDebug operator<<(QDebug debug, const Assignment &assignment); #endif /* defined(__hifi__Assignment__) */