http_basic.h

来自「AMLOGIC DPF source code」· C头文件 代码 · 共 57 行

/*******************************************************************
 * 
 *  Copyright C 2005 by Amlogic, Inc. All Rights Reserved.
 *
 *  Description: 
 *
 *  Author: Eric Knudstrup
 *  Created: Fri Apr  8 16:44:28 2005
 *
 *******************************************************************/

#ifndef HTTP_BASIC_H
#define HTTP_BASIC_H

/**
 * @file http_basic.h
 * HTTP Basic Authentication
 */
/** @addtogroup http_client */
/*@{*/

/*;emacs generated header for file http_basic.c. Global function declarations only. */
/** 
 * Create an HTTP 1.1 Authorization header and insert it into
 * the client as a static header that will be transmitted for
 * each request
 *
 * @param [in] client HTTP Client.
 * @param [in] user_name Username to use.
 * @param [in] password Password to use.
 *
 * @returns TRUE if the operation succeeded, FALSE if not.
 */
extern int
http_create_basic_auth(HTTPTcpConnection_t *client,
 char *user_name, char *password);

/**
 * Given a user_name and password, calculate the response
 * to send to the server
 *
 * @param [in] user_name Username
 * @param [in] password Password
 *
 * @returns A string allocated from the system heap. It is the
 * user's responsibility to free this string when
 * done with it to avoid a memory leak.
 */
extern char *
http_basic_auth(char *user_name, char *password);


/*;end emacs generated header for file http_basic.c. Global function declarations only. */

#endif
/*@}*/