// C# binding for Stream Framing Protocol services in libsimpleio.so

// Copyright (C)2017-2023, Philip Munts dba Munts Technologies.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
//   this list of conditions and the following disclaimer.
//
// 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.

using System.Runtime.InteropServices;

namespace IO.Bindings
{
    public static partial class libsimpleio
    {
        /// <summary>
        /// Encode a frame.
        /// </summary>
        /// <param name="src">Source buffer.</param>
        /// <param name="srclen">Source buffer size.</param>
        /// <param name="dst">Destination buffer.</param>
        /// <param name="dstsize">Destination buffer size.</param>
        /// <param name="dstlen">Size of encoded frame.</param>
        /// <param name="error">Error code.  Zero upon success or an <c>errno</c>
        /// value upon failure.</param>
        [DllImport("simpleio")]
        public static extern void STREAM_encode_frame(byte[] src, int srclen,
            byte[] dst, int dstsize, out int dstlen, out int error);

        /// <summary>
        /// Decode a frame.
        /// </summary>
        /// <param name="src">Source buffer.</param>
        /// <param name="srclen">Source buffer size.</param>
        /// <param name="dst">Destination buffer.</param>
        /// <param name="dstsize">Destination buffer size.</param>
        /// <param name="dstlen">Size of decoded frame.</param>
        /// <param name="error">Error code.  Zero upon success or an <c>errno</c>
        /// value upon failure.</param>
        [DllImport("simpleio")]
        public static extern void STREAM_decode_frame(byte[] src, int srclen,
            byte[] dst, int dstsize, out int dstlen, out int error);

        /// <summary>
        /// Receive an encoded frame.
        /// </summary>
        /// <param name="fd">File descriptior.</param>
        /// <param name="buf">Destination buffer.</param>
        /// <param name="bufsize">Destination buffer size.</param>
        /// <param name="count">Number of bytes actually received.</param>
        /// <param name="error">Error code.  Zero upon success or an <c>errno</c>
        /// value upon failure.</param>
        [DllImport("simpleio")]
        public static extern void STREAM_receive_frame(int fd, byte[] buf,
            int bufsize, out int count, out int error);

        /// <summary>
        /// Send an encoded frame.
        /// </summary>
        /// <param name="fd">File descriptor.</param>
        /// <param name="buf">Source buffer.</param>
        /// <param name="bufsize">Source buffer size.</param>
        /// <param name="count">Number of bytes actually sent.</param>
        /// <param name="error">Error code.  Zero upon success or an <c>errno</c>
        /// value upon failure.</param>
        [DllImport("simpleio")]
        public static extern void STREAM_send_frame(int fd, byte[] buf,
            int bufsize, out int count, out int error);
    }
}