rtxStreamBase64Text.h

00001 /*
00002 * Copyright (c) 2003-2017 Objective Systems, Inc.
00003 *
00004 * This software is furnished under a license and may be used and copied
00005 * only in accordance with the terms of such license and with the
00006 * inclusion of the above copyright notice. This software or any other
00007 * copies thereof may not be provided or otherwise made available to any
00008 * other person. No title to and ownership of the software is hereby
00009 * transferred.
00010 *
00011 * The information in this software is subject to change without notice
00012 * and should not be construed as a commitment by Objective Systems, Inc.
00013 *
00014 * PROPRIETARY NOTICE
00015 *
00016 * This software is an unpublished work subject to a confidentiality agreement
00017 * and is protected by copyright and trade secret law.  Unauthorized copying,
00018 * redistribution or other use of this work is prohibited.
00019 *
00020 * The above notice of copyright on this source code product does not indicate
00021 * any actual or intended publication of such source code.
00022 *
00023 *****************************************************************************/
00024 /*
00025 * @file rtxStreamBase64Text.h
00026 */
00027 #ifndef _RTXSTREAMBASE64TEXT_H_
00028 #define _RTXSTREAMBASE64TEXT_H_
00029 
00030 #ifndef _NO_STREAM
00031 
00032 #include "rtxsrc/osSysTypes.h"
00033 #include "rtxsrc/rtxExternDefs.h"
00034 #include "rtxsrc/rtxStream.h"
00035 
00036 #ifdef __cplusplus
00037 extern "C" {
00038 #endif
00039 
00040 
00041    typedef struct Base64TextStrmDesc {
00042       OSCTXT* pctxt;
00043       OSRTSTREAM* pUnderStream; /* underlying stream object */
00044       OSBOOL mbCertificate;
00045    } Base64TextStrmDesc;
00046 
00047    /*
00048    * This function initializes a Base64Text stream and attaches it to the
00049    * existing stream defined within the context.  This type of stream object
00050    * can only be used with an existing stream.  It acts as a filter to perform
00051    * conversion to/from Base64 characters to binary data.
00052    *
00053    * @param pctxt        Pointer to context structure variable.
00054    * @param flags        Specifies the access mode for the stream:
00055    *                       - OSRTSTRMF_INPUT = input (reading) stream;
00056    *                       - OSRTSTRMF_OUTPUT = output (writing) stream.
00057    * @return             Completion status of operation: 0 (0) = success,
00058    *                       negative return value is error.
00059    */
00060    EXTERNRT int rtxStreamBase64TextAttach (OSCTXT* pctxt, OSUINT16 flags);
00061 
00062 #ifdef __cplusplus
00063 }
00064 #endif
00065 
00066 #endif /* _NO_STREAM */
00067 #endif /* _RTXSTREAMBASE64TEXT_H_ */