pgbackrest/src/command/backup/protocol.h

/***********************************************************************************************************************************
Backup Protocol Handler
***********************************************************************************************************************************/
#ifndef COMMAND_BACKUP_PROTOCOL_H
#define COMMAND_BACKUP_PROTOCOL_H

#include "common/type/string.h"
#include "common/type/variantList.h"
#include "protocol/server.h"

/***********************************************************************************************************************************
Constants
***********************************************************************************************************************************/
#define PROTOCOL_COMMAND_BACKUP_FILE                               "backupFile"
    STRING_DECLARE(PROTOCOL_COMMAND_BACKUP_FILE_STR);

/***********************************************************************************************************************************
Functions
***********************************************************************************************************************************/
// Process protocol requests
bool backupProtocol(const String *command, const VariantList *paramList, ProtocolServer *server);

#endif
The local command for backup is implemented entirely in C. The local process is now entirely migrated to C. Since all major I/O operations are performed in the local process, the vast majority of I/O is now performed in C. Contributed by David Steele, Cynthia Shang. 2019-07-25 14:34:16 -04:00			`/***********************************************************************************************************************************`
			`Backup Protocol Handler`
			`***********************************************************************************************************************************/`
			`#ifndef COMMAND_BACKUP_PROTOCOL_H`
			`#define COMMAND_BACKUP_PROTOCOL_H`

			`#include "common/type/string.h"`
			`#include "common/type/variantList.h"`
			`#include "protocol/server.h"`

			`/***********************************************************************************************************************************`
			`Constants`
			`***********************************************************************************************************************************/`
			`#define PROTOCOL_COMMAND_BACKUP_FILE "backupFile"`
			`STRING_DECLARE(PROTOCOL_COMMAND_BACKUP_FILE_STR);`

			`/***********************************************************************************************************************************`
			`Functions`
			`***********************************************************************************************************************************/`
Move extern function comments to headers. This has been the policy for some time but due to migration pressure only new functions and refactors have been following this rule. Now it seems sensible to make a clean sweep and move all the comments that have not been moved already (i.e. most of them). Only obvious typos and gross inaccuracies in the comments have been fixed. For this most part this was a copy and paste operation. Useless comments, e.g. "New object", were not copied. Even so, there are surely many deficient comments left. Some rearranging was done where needed and functions were placed in the proper sections, e.g. "Constructors", "Functions", etc. A few function prototypes were found that not longer had an implementation. These were removed, but there may be more. The coding document has been updated to reflect this policy, which is not new but has never been documented. 2020-04-03 18:01:28 -04:00			`// Process protocol requests`
The local command for backup is implemented entirely in C. The local process is now entirely migrated to C. Since all major I/O operations are performed in the local process, the vast majority of I/O is now performed in C. Contributed by David Steele, Cynthia Shang. 2019-07-25 14:34:16 -04:00			`bool backupProtocol(const String command, const VariantList paramList, ProtocolServer *server);`

			`#endif`