HttpDynamicCommand.c File Reference

#include <Protocol/ShellDynamicCommand.h>
#include "Http.h"

Go to the source code of this file.

Functions
SHELL_STATUS EFIAPI	HttpCommandHandler (IN EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL *This, IN EFI_SYSTEM_TABLE *SystemTable, IN EFI_SHELL_PARAMETERS_PROTOCOL *ShellParameters, IN EFI_SHELL_PROTOCOL *Shell)
CHAR16 *EFIAPI	HttpCommandGetHelp (IN EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL *This, IN CONST CHAR8 *Language)
EFI_STATUS EFIAPI	HttpCommandInitialize (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
EFI_STATUS EFIAPI	HttpUnload (IN EFI_HANDLE ImageHandle)

Variables
EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL	mHttpDynamicCommand

Detailed Description

Produce "http" shell dynamic command.

Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.
Copyright (c) 2015, ARM Ltd. All rights reserved.
Copyright (c) 2020, Broadcom. All rights reserved.

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

Definition in file HttpDynamicCommand.c.

Function Documentation

HttpCommandGetHelp()

CHAR16 *EFIAPI HttpCommandGetHelp	(	IN EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL *	This,
		IN CONST CHAR8 *	Language
	)

This is the command help handler function pointer callback type. This function is responsible for displaying help information for the associated command.

Parameters

[in]	This	The instance of the EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL.
[in]	Language	The pointer to the language string to use.

Returns

string Pool allocated help string, must be freed by caller

Definition at line 55 of file HttpDynamicCommand.c.

HttpCommandHandler()

SHELL_STATUS EFIAPI HttpCommandHandler	(	IN EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL *	This,
		IN EFI_SYSTEM_TABLE *	SystemTable,
		IN EFI_SHELL_PARAMETERS_PROTOCOL *	ShellParameters,
		IN EFI_SHELL_PROTOCOL *	Shell
	)

This is the shell command handler function pointer callback type. This function handles the command when it is invoked in the shell.

Parameters

[in]	This	The instance of the EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL.
[in]	SystemTable	The pointer to the system table.
[in]	ShellParameters	The parameters associated with the command.
[in]	Shell	The instance of the shell protocol used in the context of processing this command.

Returns

EFI_SUCCESS the operation was successful

other the operation failed.

Definition at line 30 of file HttpDynamicCommand.c.

HttpCommandInitialize()

EFI_STATUS EFIAPI HttpCommandInitialize	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Entry point of Http Dynamic Command.

Produce the DynamicCommand protocol to handle "http" command.

Parameters

ImageHandle	The image handle of the process.
SystemTable	The EFI System Table pointer.

Return values

EFI_SUCCESS	Http command is executed successfully.
EFI_ABORTED	HII package was failed to initialize.
others	Other errors when executing http command.

Definition at line 87 of file HttpDynamicCommand.c.

HttpUnload()

EFI_STATUS EFIAPI HttpUnload

(

IN EFI_HANDLE

ImageHandle

)

Http driver unload handler.

Parameters

ImageHandle

The image handle of the process.

Return values

EFI_SUCCESS	The image is unloaded.
Others	Failed to unload the image.

Definition at line 119 of file HttpDynamicCommand.c.

Variable Documentation

mHttpDynamicCommand

EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL mHttpDynamicCommand

Initial value:

= {
  HTTP_APP_NAME,
  HttpCommandHandler,
  HttpCommandGetHelp
}

Definition at line 67 of file HttpDynamicCommand.c.