RestExLib.h 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. /** @file
  2. This library provides help functions for REST EX Protocol.
  3. (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>
  4. SPDX-License-Identifier: BSD-2-Clause-Patent
  5. **/
  6. #ifndef REST_EX_LIB_H_
  7. #define REST_EX_LIB_H_
  8. #include <Protocol/RestEx.h>
  9. ///
  10. /// Library class public functions
  11. ///
  12. /**
  13. This function allows the caller to create child handle for specific
  14. REST server.
  15. @param[in] Image The image handle used to open service.
  16. @param[in] AccessMode Access mode of REST server.
  17. @param[in] ConfigType Underlying configuration to communicate with REST server.
  18. @param[in] ServiceType REST service type.
  19. @param[out] ChildInstanceHandle The handle to receive the create child.
  20. @retval EFI_SUCCESS Can't create the corresponding REST EX child instance.
  21. @retval EFI_INVALID_PARAMETERS Any of input parameters is improper.
  22. **/
  23. EFI_STATUS
  24. RestExLibCreateChild (
  25. IN EFI_HANDLE Image,
  26. IN EFI_REST_EX_SERVICE_ACCESS_MODE AccessMode,
  27. IN EFI_REST_EX_CONFIG_TYPE ConfigType,
  28. IN EFI_REST_EX_SERVICE_TYPE ServiceType,
  29. OUT EFI_HANDLE *ChildInstanceHandle
  30. );
  31. #endif