redfishPayload.h File Reference

#include <Include/Library/RedfishCrtLib.h>
#include <Library/JsonLib.h>
#include <jansson.h>
#include <redfishService.h>
#include <redpath.h>

Go to the source code of this file.

Functions
redfishPayload *	createRedfishPayload (json_t *value, redfishService *service)
redfishPayload *	getPayloadByNodeName (redfishPayload *payload, const char *nodeName, EFI_HTTP_STATUS_CODE **StatusCode)
redfishPayload *	getPayloadByIndex (redfishPayload *payload, size_t index, EFI_HTTP_STATUS_CODE **StatusCode)
redfishPayload *	getPayloadForPath (redfishPayload *payload, redPathNode *redpath, EFI_HTTP_STATUS_CODE **StatusCode)
redfishPayload *	getPayloadForPathString (redfishPayload *payload, const char *string, EFI_HTTP_STATUS_CODE **StatusCode)
redfishPayload *	patchPayload (redfishPayload *target, redfishPayload *payload, EFI_HTTP_STATUS_CODE **StatusCode)
redfishPayload *	postContentToPayload (redfishPayload *target, const char *data, size_t dataSize, const char *contentType, EFI_HTTP_STATUS_CODE **StatusCode)
redfishPayload *	postPayload (redfishPayload *target, redfishPayload *payload, EFI_HTTP_STATUS_CODE **StatusCode)
void	cleanupPayload (redfishPayload *payload)
bool	isPayloadCollection (redfishPayload *Payload)
size_t	getCollectionSize (redfishPayload *payload)

Detailed Description

This file is cloned from DMTF libredfish library tag v1.0.0 and maintained by EDKII.

---

Copyright Notice: Copyright 2017 Distributed Management Task Force, Inc. All rights reserved.

License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/libredfish/LICENSE.md

Copyright (c) 2019, Intel Corporation. All rights reserved.
(C) Copyright 2021 Hewlett Packard Enterprise Development LP
Copyright (c) 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file redfishPayload.h.

Function Documentation

cleanupPayload()

void cleanupPayload

(

redfishPayload *

payload

)

Definition at line 483 of file payload.c.

createRedfishPayload()

redfishPayload * createRedfishPayload	(	json_t *	value,
		redfishService *	service
	)

Definition at line 130 of file payload.c.

getCollectionSize()

size_t getCollectionSize

(

redfishPayload *

payload

)

Definition at line 78 of file payload.c.

getPayloadByIndex()

redfishPayload * getPayloadByIndex	(	redfishPayload *	payload,
		size_t	index,
		EFI_HTTP_STATUS_CODE **	StatusCode
	)

Definition at line 196 of file payload.c.

getPayloadByNodeName()

redfishPayload * getPayloadByNodeName	(	redfishPayload *	payload,
		const char *	nodeName,
		EFI_HTTP_STATUS_CODE **	StatusCode
	)

Definition at line 147 of file payload.c.

getPayloadForPath()

redfishPayload * getPayloadForPath	(	redfishPayload *	payload,
		redPathNode *	redpath,
		EFI_HTTP_STATUS_CODE **	StatusCode
	)

Definition at line 278 of file payload.c.

getPayloadForPathString()

redfishPayload * getPayloadForPathString	(	redfishPayload *	payload,
		const char *	string,
		EFI_HTTP_STATUS_CODE **	StatusCode
	)

Definition at line 358 of file payload.c.

isPayloadCollection()

bool isPayloadCollection

(

redfishPayload *

Payload

)

Definition at line 61 of file payload.c.

patchPayload()

redfishPayload * patchPayload	(	redfishPayload *	target,
		redfishPayload *	payload,
		EFI_HTTP_STATUS_CODE **	StatusCode
	)

Definition at line 384 of file payload.c.

postContentToPayload()

redfishPayload * postContentToPayload	(	redfishPayload *	target,
		const char *	data,
		size_t	dataSize,
		const char *	contentType,
		EFI_HTTP_STATUS_CODE **	StatusCode
	)

Definition at line 421 of file payload.c.

postPayload()

redfishPayload * postPayload	(	redfishPayload *	target,
		redfishPayload *	payload,
		EFI_HTTP_STATUS_CODE **	StatusCode
	)

Definition at line 457 of file payload.c.