message.h File Reference

#include "access/xlog.h"
#include "access/xlogdefs.h"
#include "access/xlogreader.h"

Include dependency graph for message.h:

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

Go to the source code of this file.

Data Structures
struct	xl_logical_message

Macros
#define	SizeOfLogicalMessage   (offsetof(xl_logical_message, message))
#define	XLOG_LOGICAL_MESSAGE   0x00

Typedefs
typedef struct xl_logical_message	xl_logical_message

Functions
XLogRecPtr	LogLogicalMessage (const char *prefix, const char *message, size_t size, bool transactional, bool flush)
void	logicalmsg_redo (XLogReaderState *record)
void	logicalmsg_desc (StringInfo buf, XLogReaderState *record)
const char *	logicalmsg_identify (uint8 info)

Macro Definition Documentation

SizeOfLogicalMessage

#define SizeOfLogicalMessage   (offsetof(xl_logical_message, message))

Definition at line 30 of file message.h.

XLOG_LOGICAL_MESSAGE

#define XLOG_LOGICAL_MESSAGE   0x00

Definition at line 37 of file message.h.

Typedef Documentation

xl_logical_message

typedef struct xl_logical_message xl_logical_message

Function Documentation

logicalmsg_desc()

void logicalmsg_desc	(	StringInfo	buf,
		XLogReaderState *	record
	)

Definition at line 19 of file logicalmsgdesc.c.

{
    char       *rec = XLogRecGetData(record);
    uint8       info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;
 
    if (info == XLOG_LOGICAL_MESSAGE)
    {
        xl_logical_message *xlrec = (xl_logical_message *) rec;
        char       *prefix = xlrec->message;
        char       *message = xlrec->message + xlrec->prefix_size;
        char       *sep = "";
 
        Assert(prefix[xlrec->prefix_size - 1] == '\0');
 
        appendStringInfo(buf, "%s, prefix \"%s\"; payload (%zu bytes): ",
                         xlrec->transactional ? "transactional" : "non-transactional",
                         prefix, xlrec->message_size);
        /* Write message payload as a series of hex bytes */
        for (int cnt = 0; cnt < xlrec->message_size; cnt++)
        {
            appendStringInfo(buf, "%s%02X", sep, (unsigned char) message[cnt]);
            sep = " ";
        }
    }
}

References appendStringInfo(), Assert, buf, xl_logical_message::message, xl_logical_message::message_size, xl_logical_message::prefix_size, xl_logical_message::transactional, XLOG_LOGICAL_MESSAGE, XLogRecGetData, XLogRecGetInfo, and XLR_INFO_MASK.

logicalmsg_identify()

const char* logicalmsg_identify

(

uint8

info

)

Definition at line 46 of file logicalmsgdesc.c.

{
    if ((info & ~XLR_INFO_MASK) == XLOG_LOGICAL_MESSAGE)
        return "MESSAGE";
 
    return NULL;
}

References XLOG_LOGICAL_MESSAGE, and XLR_INFO_MASK.

logicalmsg_redo()

void logicalmsg_redo

(

XLogReaderState *

record

)

Definition at line 87 of file message.c.

{
    uint8       info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;
 
    if (info != XLOG_LOGICAL_MESSAGE)
        elog(PANIC, "logicalmsg_redo: unknown op code %u", info);
 
    /* This is only interesting for logical decoding, see decode.c. */
}

References elog, PANIC, XLOG_LOGICAL_MESSAGE, XLogRecGetInfo, and XLR_INFO_MASK.

LogLogicalMessage()

XLogRecPtr LogLogicalMessage	(	const char *	prefix,
		const char *	message,
		size_t	size,
		bool	transactional,
		bool	flush
	)

Definition at line 43 of file message.c.

{
    xl_logical_message xlrec;
    XLogRecPtr  lsn;
 
    /*
     * Force xid to be allocated if we're emitting a transactional message.
     */
    if (transactional)
    {
        Assert(IsTransactionState());
        GetCurrentTransactionId();
    }
 
    xlrec.dbId = MyDatabaseId;
    xlrec.transactional = transactional;
    /* trailing zero is critical; see logicalmsg_desc */
    xlrec.prefix_size = strlen(prefix) + 1;
    xlrec.message_size = size;
 
    XLogBeginInsert();
    XLogRegisterData((char *) &xlrec, SizeOfLogicalMessage);
    XLogRegisterData(unconstify(char *, prefix), xlrec.prefix_size);
    XLogRegisterData(unconstify(char *, message), size);
 
    /* allow origin filtering */
    XLogSetRecordFlags(XLOG_INCLUDE_ORIGIN);
 
    lsn = XLogInsert(RM_LOGICALMSG_ID, XLOG_LOGICAL_MESSAGE);
 
    /*
     * Make sure that the message hits disk before leaving if emitting a
     * non-transactional message when flush is requested.
     */
    if (!transactional && flush)
        XLogFlush(lsn);
    return lsn;
}

References Assert, xl_logical_message::dbId, GetCurrentTransactionId(), IsTransactionState(), xl_logical_message::message_size, MyDatabaseId, xl_logical_message::prefix_size, size, SizeOfLogicalMessage, xl_logical_message::transactional, unconstify, XLOG_INCLUDE_ORIGIN, XLOG_LOGICAL_MESSAGE, XLogBeginInsert(), XLogFlush(), XLogInsert(), XLogRegisterData(), and XLogSetRecordFlags().

Referenced by pg_logical_emit_message_bytea().