ActionParams.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2022 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */
 
/* DEBUG: section 16    Cache Manager API */
 
#ifndef SQUID_MGR_ACTION_PARAMS_H
#define SQUID_MGR_ACTION_PARAMS_H
 
#include "http/RequestMethod.h"
#include "ipc/forward.h"
#include "mgr/QueryParams.h"
#include "RequestFlags.h"
 
namespace Mgr
{
 
class ActionParams
{
public:
    ActionParams();
 
    explicit ActionParams(const Ipc::TypedMsgHdr &msg); 
    void pack(Ipc::TypedMsgHdr &msg) const; 
 
public:
    /* details of the client HTTP request that caused the action */
    String httpUri; 
    HttpRequestMethod httpMethod; 
    RequestFlags httpFlags; 
    String httpOrigin;       
 
    /* action parameters extracted from the client HTTP request */
    String actionName; 
    String userName; 
    String password; 
    QueryParams queryParams;
};
 
} // namespace Mgr
 
std::ostream &operator <<(std::ostream &os, const Mgr::ActionParams &params);
 
#endif /* SQUID_MGR_ACTION_PARAMS_H */