code/owire.h

Go to the documentation of this file.

#ifndef _owire_h__
#define _owire_h__

// Copyright (c) 2011-2012, Andre Caron (andre.l.caron@gmail.com)
// All rights reserved.
// 
// 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.
// 
//   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.
// 
// 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.

#include "types.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef uint64(*ws_owire_state)
    (struct ws_owire*,const uint8*,uint64);

enum ws_owire_error
{
    ws_owire_eok,
    ws_owire_enotready,
};

struct ws_owire
{
    // event callbacks.
    void(*accept_content)(struct ws_owire*,const void*,uint64);
    void(*rand)(struct ws_owire*,uint8 mask[4]);

    // for use by callbacks.
    void * baton;
    void * prng;

    // read-only fields.
    enum ws_owire_error error;

    // public fields.
    uint64 auto_fragment;
    int auto_mask;

    // internal state.
    uint8 data[14];
    uint64 used;
    uint64 pass;
    ws_owire_state state;
};

void ws_owire_init ( struct ws_owire * stream );

void ws_owire_new_message ( struct ws_owire * stream );
void ws_owire_end_message ( struct ws_owire * stream );

void ws_owire_new_frame ( struct ws_owire * stream, uint64 size );
void ws_owire_end_frame ( struct ws_owire * stream );

void ws_owire_last ( struct ws_owire * stream );
void ws_owire_eval ( struct ws_owire * stream, uint8 eval );
void ws_owire_code ( struct ws_owire * stream, uint8 code );
void ws_owire_mask ( struct ws_owire * stream );
uint64 ws_owire_feed
    ( struct ws_owire * stream, const void * data, uint64 size );

  // Follow with calls to _feed(), _end_frame(), etc.
void ws_owire_ping ( struct ws_owire * stream );
void ws_owire_pong ( struct ws_owire * stream );
void ws_owire_text ( struct ws_owire * stream );
void ws_owire_data ( struct ws_owire * stream );
void ws_owire_kill ( struct ws_owire * stream );

  // emit full frames in a single bundle.
void ws_owire_put_text
    ( struct ws_owire * stream, const void * data, uint64 size );
void ws_owire_put_data
    ( struct ws_owire * stream, const void * data, uint64 size );
void ws_owire_put_ping
    ( struct ws_owire * stream, const void * data, uint64 size );
void ws_owire_put_pong
    ( struct ws_owire * stream, const void * data, uint64 size );
void ws_owire_put_kill
    ( struct ws_owire * stream, const void * data, uint64 size );

#ifdef __cplusplus
}
#endif

#endif /* _owire_h__ */