management.h

/*
 * Copyright (C) 2022 Red Hat
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this list
 * of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this
 * list of conditions and the following disclaimer in the documentation and/or other
 * materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors may
 * be used to endorse or promote products derived from this software without specific
 * prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef PGMONETA_MANAGEMENT_H
#define PGMONETA_MANAGEMENT_H

#ifdef __cplusplus
extern "C" {
#endif

#include <pgmoneta.h>

#include <stdbool.h>
#include <stdlib.h>

#include <openssl/ssl.h>

#define MANAGEMENT_BACKUP      0
#define MANAGEMENT_LIST_BACKUP 1
#define MANAGEMENT_RESTORE     2
#define MANAGEMENT_ARCHIVE     3
#define MANAGEMENT_DELETE      4
#define MANAGEMENT_STOP        5
#define MANAGEMENT_STATUS      6
#define MANAGEMENT_DETAILS     7
#define MANAGEMENT_ISALIVE     8
#define MANAGEMENT_RESET       9
#define MANAGEMENT_RELOAD     10
#define MANAGEMENT_RETAIN     11
#define MANAGEMENT_EXPUNGE    12

/**
 * Read the management header
 * @param socket The socket descriptor
 * @param id The resulting management identifier
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_read_header(int socket, signed char* id);

/**
 * Read the management payload
 * @param socket The socket descriptor
 * @param id The management identifier
 * @param payload_s1 The resulting string payload
 * @param payload_s2 The resulting string payload
 * @param payload_s3 The resulting string payload
 * @param payload_s4 The resulting string payload
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_read_payload(int socket, signed char id, char** payload_s1, char** payload_s2, char** payload_s3, char** payload_s4);

/**
 * Management operation: Backup a server
 * @param ssl The SSL connection
 * @param socket The socket descriptor
 * @param server The server name
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_backup(SSL* ssl, int socket, char* server);

/**
 * Management operation: List backups for a server
 * @param ssl The SSL connection
 * @param socket The socket descriptor
 * @param server The server name
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_list_backup(SSL* ssl, int socket, char* server);

/**
 * Management operation: List backups for a server (Read)
 * @param ssl The SSL connection
 * @param socket The socket descriptor
 * @param server The server name
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_read_list_backup(SSL* ssl, int socket, char* server);

/**
 * Management operation: List backups for a server (Write)
 * @param socket The socket descriptor
 * @param server The server index
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_write_list_backup(int socket, int server);

/**
 * Management operation: Restore a server
 * @param ssl The SSL connection
 * @param socket The socket descriptor
 * @param server The server name
 * @param backup_id The backup identifier
 * @param position The position
 * @param directory The directory
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_restore(SSL* ssl, int socket, char* server, char* backup_id, char* position, char* directory);

/**
 * Management operation: Archive a server
 * @param ssl The SSL connection
 * @param socket The socket descriptor
 * @param server The server name
 * @param backup_id The backup identifier
 * @param position The position
 * @param directory The directory
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_archive(SSL* ssl, int socket, char* server, char* backup_id, char* position, char* directory);

/**
 * Management operation: Delete a backup for a server
 * @param ssl The SSL connection
 * @param socket The socket descriptor
 * @param server The server name
 * @param backup_id The backup id
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_delete(SSL* ssl, int socket, char* server, char* backup_id);

/**
 * Management operation: Delete a backup for a server (Read)
 * @param ssl The SSL connection
 * @param socket The socket descriptor
 * @param server The server name
 * @param backup_id The backup identifier
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_read_delete(SSL* ssl, int socket, char* server, char* backup_id);

/**
 * Management operation: Delete a backup for a server (Write)
 * @param socket The socket descriptor
 * @param server The server index
 * @param result The result
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_write_delete(int socket, int server, int result);

/**
 * Management operation: Stop
 * @param ssl The SSL connection
 * @param socket The socket descriptor
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_stop(SSL* ssl, int socket);

/**
 * Management operation: Status
 * @param ssl The SSL connection
 * @param socket The socket descriptor
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_status(SSL* ssl, int socket);

/**
 * Management: Read status
 * @param socket The socket
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_read_status(SSL* ssl, int socket);

/**
 * Management: Write status
 * @param socket The socket
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_write_status(int socket);

/**
 * Management operation: Details
 * @param ssl The SSL connection
 * @param socket The socket
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_details(SSL* ssl, int socket);

/**
 * Management: Read details
 * @param socket The socket
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_read_details(SSL* ssl, int socket);

/**
 * Management: Write details
 * @param socket The socket
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_write_details(int socket);

/**
 * Management operation: isalive
 * @param socket The socket
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_isalive(SSL* ssl, int socket);

/**
 * Management: Read isalive
 * @param socket The socket
 * @param status The resulting status
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_read_isalive(SSL* ssl, int socket, int* status);

/**
 * Management: Write isalive
 * @param socket The socket
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_write_isalive(int socket);

/**
 * Management operation: Reset
 * @param ssl The SSL connection
 * @param socket The socket
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_reset(SSL* ssl, int socket);

/**
 * Management operation: Reload
 * @param ssl The SSL connection
 * @param socket The socket
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_reload(SSL* ssl, int socket);

/**
 * Management operation: Retain a backup for a server
 * @param ssl The SSL connection
 * @param socket The socket descriptor
 * @param server The server name
 * @param backup_id The backup id
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_retain(SSL* ssl, int socket, char* server, char* backup_id);

/**
 * Management operation: Expunge a backup for a server
 * @param ssl The SSL connection
 * @param socket The socket descriptor
 * @param server The server name
 * @param backup_id The backup id
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_expunge(SSL* ssl, int socket, char* server, char* backup_id);

/**
 * Management: Read int32
 * @param socket The socket
 * @param status The resulting status
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_read_int32(SSL* ssl, int socket, int* status);

/**
 * Management: Write int32
 * @param socket The socket
 * @param code The code
 * @return 0 upon success, otherwise 1
 */
int
pgmoneta_management_write_int32(int socket, int code);

#ifdef __cplusplus
}
#endif

#endif