LeOS-Genesis/external/badvpn/nspr_support/DummyPRFileDesc.h

62 lines
2.3 KiB
C

/**
* @file DummyPRFileDesc.h
* @author Ambroz Bizjak <ambrop7@gmail.com>
*
* @section LICENSE
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the author nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* @section DESCRIPTION
*
* Dummy NSPR file descriptor (PRFileDesc).
* Used for creating a model SSL file descriptor to cache various stuff
* to improve performance.
*/
#ifndef BADVPN_NSPRSUPPORT_DUMMYPRFILEDESC_H
#define BADVPN_NSPRSUPPORT_DUMMYPRFILEDESC_H
#include <prio.h>
#include <misc/debug.h>
extern PRDescIdentity dummyprfiledesc_identity;
/**
* Globally initialize the dummy NSPR file descriptor backend.
* Must not have been called successfully.
*
* @return 1 on success, 0 on failure
*/
int DummyPRFileDesc_GlobalInit (void) WARN_UNUSED;
/**
* Creates a dummy NSPR file descriptor.
* {@link DummyPRFileDesc_GlobalInit} must have been done.
*
* @param prfd uninitialized PRFileDesc structure
*/
void DummyPRFileDesc_Create (PRFileDesc *prfd);
#endif