2010-12-06 17:03:22 +00:00
|
|
|
/*
|
|
|
|
* virnetmessage.h: basic RPC message encoding/decoding
|
|
|
|
*
|
|
|
|
* Copyright (C) 2010-2011 Red Hat, Inc.
|
|
|
|
*
|
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
|
|
* License as published by the Free Software Foundation; either
|
|
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This library is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
* Lesser General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
|
|
* License along with this library; if not, write to the Free Software
|
|
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __VIR_NET_MESSAGE_H__
|
|
|
|
# define __VIR_NET_MESSAGE_H__
|
|
|
|
|
|
|
|
# include "virnetprotocol.h"
|
|
|
|
|
|
|
|
typedef struct virNetMessageHeader *virNetMessageHeaderPtr;
|
|
|
|
typedef struct virNetMessageError *virNetMessageErrorPtr;
|
|
|
|
|
|
|
|
typedef struct _virNetMessage virNetMessage;
|
|
|
|
typedef virNetMessage *virNetMessagePtr;
|
|
|
|
|
2011-05-16 17:13:11 +00:00
|
|
|
typedef void (*virNetMessageFreeCallback)(virNetMessagePtr msg, void *opaque);
|
|
|
|
|
2010-12-06 17:03:22 +00:00
|
|
|
/* Never allocate this (huge) buffer on the stack. Always
|
|
|
|
* use virNetMessageNew() to allocate on the heap
|
|
|
|
*/
|
|
|
|
struct _virNetMessage {
|
|
|
|
char buffer[VIR_NET_MESSAGE_MAX + VIR_NET_MESSAGE_LEN_MAX];
|
|
|
|
size_t bufferLength;
|
|
|
|
size_t bufferOffset;
|
|
|
|
|
|
|
|
virNetMessageHeader header;
|
|
|
|
|
2011-05-16 17:13:11 +00:00
|
|
|
virNetMessageFreeCallback cb;
|
|
|
|
void *opaque;
|
|
|
|
|
2010-12-06 17:03:22 +00:00
|
|
|
virNetMessagePtr next;
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
virNetMessagePtr virNetMessageNew(void);
|
|
|
|
|
|
|
|
void virNetMessageFree(virNetMessagePtr msg);
|
|
|
|
|
|
|
|
virNetMessagePtr virNetMessageQueueServe(virNetMessagePtr *queue)
|
|
|
|
ATTRIBUTE_NONNULL(1);
|
|
|
|
void virNetMessageQueuePush(virNetMessagePtr *queue,
|
|
|
|
virNetMessagePtr msg)
|
|
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
|
|
|
|
|
|
|
|
int virNetMessageEncodeHeader(virNetMessagePtr msg)
|
|
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK;
|
|
|
|
int virNetMessageDecodeLength(virNetMessagePtr msg)
|
|
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK;
|
|
|
|
int virNetMessageDecodeHeader(virNetMessagePtr msg)
|
|
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK;
|
|
|
|
|
|
|
|
int virNetMessageEncodePayload(virNetMessagePtr msg,
|
|
|
|
xdrproc_t filter,
|
|
|
|
void *data)
|
|
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(2) ATTRIBUTE_RETURN_CHECK;
|
|
|
|
int virNetMessageDecodePayload(virNetMessagePtr msg,
|
|
|
|
xdrproc_t filter,
|
|
|
|
void *data)
|
|
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(2) ATTRIBUTE_RETURN_CHECK;
|
|
|
|
|
|
|
|
int virNetMessageEncodePayloadRaw(virNetMessagePtr msg,
|
|
|
|
const char *buf,
|
|
|
|
size_t len)
|
|
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK;
|
|
|
|
|
|
|
|
void virNetMessageSaveError(virNetMessageErrorPtr rerr)
|
|
|
|
ATTRIBUTE_NONNULL(1);
|
|
|
|
|
|
|
|
#endif /* __VIR_NET_MESSAGE_H__ */
|