nfv/guest-client/guest-client-3.0.1/guest_client_api/guest_api_stream.h

93 lines
3.7 KiB
C
Executable File

/*
* Copyright (c) 2013-2016, Wind River Systems, Inc.
*
* 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 Wind River Systems 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 COPYRIGHT HOLDER OR CONTRIBUTORS 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.
*/
#ifndef __GUEST_API_STREAM_H__
#define __GUEST_API_STREAM_H__
#include <stdbool.h>
#include "guest_api_types.h"
#ifdef __cplusplus
extern "C" {
#endif
typedef struct {
char* delimiter;
int delimiter_size;
char* end_ptr;
char* bytes;
int avail;
int size;
int max_size;
} GuestApiStreamT;
// ****************************************************************************
// Guest API Stream - Get
// ======================
extern int guest_api_stream_get( GuestApiStreamT* stream );
// ****************************************************************************
// ****************************************************************************
// Guest API Stream - Get Next
// ===========================
extern bool guest_api_stream_get_next( GuestApiStreamT* stream );
// ****************************************************************************
// ****************************************************************************
// Guest API Stream - Advance
// ==========================
extern void guest_api_stream_advance( int adv, GuestApiStreamT* stream );
// ****************************************************************************
// ****************************************************************************
// Guest API Stream - Reset
// ========================
extern void guest_api_stream_reset( GuestApiStreamT* stream );
// ****************************************************************************
// ****************************************************************************
// Guest API Stream - Setup
// ========================
extern GuestApiErrorT guest_api_stream_setup(
const char* delimiter, int delimiter_size, int stream_size,
GuestApiStreamT* stream );
// ****************************************************************************
// ****************************************************************************
// Guest API Stream - Release
// ==========================
extern GuestApiErrorT guest_api_stream_release( GuestApiStreamT* stream );
// ****************************************************************************
#ifdef __cplusplus
}
#endif
#endif /* __GUEST_API_STREAM_H__ */