basebackup_target.h File Reference

#include "backup/basebackup_sink.h"

Include dependency graph for basebackup_target.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef struct BaseBackupTargetHandle	BaseBackupTargetHandle

Functions
void	BaseBackupAddTarget (char *name, void *(*check_detail)(char *, char *), bbsink *(*get_sink)(bbsink *, void *))
BaseBackupTargetHandle *	BaseBackupGetTargetHandle (char *target, char *target_detail)
bbsink *	BaseBackupGetSink (BaseBackupTargetHandle *handle, bbsink *next_sink)

Typedef Documentation

BaseBackupTargetHandle

typedef struct BaseBackupTargetHandle BaseBackupTargetHandle

Definition at line 18 of file basebackup_target.h.

Function Documentation

BaseBackupAddTarget()

void BaseBackupAddTarget ( char *  name, void *(*)(char *, char *)  check_detail, bbsink *(*)(bbsink *, void *)  get_sink  )

extern

Definition at line 61 of file basebackup_target.c.

{
    BaseBackupTargetType *newtype;
    MemoryContext oldcontext;
    ListCell   *lc;
 
    /* If the target list is not yet initialized, do that first. */
    if (BaseBackupTargetTypeList == NIL)
        initialize_target_list();
 
    /* Search the target type list for an existing entry with this name. */
    foreach(lc, BaseBackupTargetTypeList)
    {
        BaseBackupTargetType *ttype = lfirst(lc);
 
        if (strcmp(ttype->name, name) == 0)
        {
            /*
             * We found one, so update it.
             *
             * It is probably not a great idea to call BaseBackupAddTarget for
             * the same name multiple times, but if it happens, this seems
             * like the sanest behavior.
             */
            ttype->check_detail = check_detail;
            ttype->get_sink = get_sink;
            return;
        }
    }
 
    /*
     * We use TopMemoryContext for allocations here to make sure that the data
     * we need doesn't vanish under us; that's also why we copy the target
     * name into a newly-allocated chunk of memory.
     */
    oldcontext = MemoryContextSwitchTo(TopMemoryContext);
    newtype = palloc_object(BaseBackupTargetType);
    newtype->name = pstrdup(name);
    newtype->check_detail = check_detail;
    newtype->get_sink = get_sink;
    BaseBackupTargetTypeList = lappend(BaseBackupTargetTypeList, newtype);
    MemoryContextSwitchTo(oldcontext);
}

References BaseBackupTargetTypeList, BaseBackupTargetType::check_detail, fb(), BaseBackupTargetType::get_sink, initialize_target_list(), lappend(), lfirst, MemoryContextSwitchTo(), BaseBackupTargetType::name, name, NIL, palloc_object, pstrdup(), and TopMemoryContext.

Referenced by _PG_init().

BaseBackupGetSink()

bbsink * BaseBackupGetSink ( BaseBackupTargetHandle *  handle, bbsink *  next_sink  )

extern

Definition at line 163 of file basebackup_target.c.

{
    return handle->type->get_sink(next_sink, handle->detail_arg);
}

References BaseBackupTargetHandle::detail_arg, fb(), BaseBackupTargetType::get_sink, and BaseBackupTargetHandle::type.

Referenced by SendBaseBackup().

BaseBackupGetTargetHandle()

BaseBackupTargetHandle * BaseBackupGetTargetHandle ( char *  target, char *  target_detail  )

extern

Definition at line 117 of file basebackup_target.c.

{
    ListCell   *lc;
 
    /* If the target list is not yet initialized, do that first. */
    if (BaseBackupTargetTypeList == NIL)
        initialize_target_list();
 
    /* Search the target type list for a match. */
    foreach(lc, BaseBackupTargetTypeList)
    {
        BaseBackupTargetType *ttype = lfirst(lc);
 
        if (strcmp(ttype->name, target) == 0)
        {
            BaseBackupTargetHandle *handle;
 
            /* Found the target. */
            handle = palloc_object(BaseBackupTargetHandle);
            handle->type = ttype;
            handle->detail_arg = ttype->check_detail(target, target_detail);
 
            return handle;
        }
    }
 
    /* Did not find the target. */
    ereport(ERROR,
            (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
             errmsg("unrecognized target: \"%s\"", target)));
 
    /* keep compiler quiet */
    return NULL;
}

References BaseBackupTargetTypeList, BaseBackupTargetType::check_detail, BaseBackupTargetHandle::detail_arg, ereport, errcode(), errmsg(), ERROR, fb(), initialize_target_list(), lfirst, BaseBackupTargetType::name, NIL, palloc_object, and BaseBackupTargetHandle::type.

Referenced by parse_basebackup_options().