NET_WebAPIResponse.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        NET_WebAPIResponse.h
 *
 * COMMENTS:
 *
 */

#ifndef __NET_WEBAPIRESPONSE_H__
#define __NET_WEBAPIRESPONSE_H__

#include "NET_API.h"

#include "NET_WebResponse.h"
#include "NET_WebTypes.h"

#include <UT/UT_JSONValue.h>
#include <UT/UT_StringHolder.h>
#include <UT/UT_SGuid.h>

class NET_API NET_WebAPIResponse
{
public:
    enum Type
    {
        HTTP,
        WebSocket
    };

    NET_WebAPIResponse() = default;
    NET_WebAPIResponse(NET_HTTPResponse&& resp);

    void setAsHTTP(NET_HTTPResponse&& resp);
    /// @brief Parse a websocket response.
    ///
    /// @param resp The response from a websocket api request.
    ///
    /// @return True if the parse was a success.
    bool parseWebSocket(const UT_StringHolder& resp);

    NET_HTTPStatusCode myStatus;
    NET_HTTPResponse::HeaderMap myHeaders;
    UT_StringArray myCookies;
    NET_HTTPResponse::Error myError;
    // The body of the response
    UT_StringHolder myData;

    const UT_JSONValue* json() { return myCommand; }
    Type type() const { return myType; }
    UT_StringHolder idToString() const
    {
        return myId.toString();
    }
    const UT_SGuid& id() const
    {
        return myId;
    }
private:
    Type myType;

// ==========================================
// WebSocket specific data
// ==========================================
    UT_JSONValue myJSON;
    UT_SGuid myId;
    UT_JSONValue* myCommand = nullptr;
};

#endif // __NET_WEBAPIRESPONSE_H__