enums.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2001 by Rick L. Vinyard, Jr.                            *
 *   rvinyard@cs.nmsu.edu                                                  *
 *                                                                         *
 *   This file is part of the conexus library.                             *
 *                                                                         *
 *   The conexus library is free software; you can redistribute it and/or  *
 *   modify it under the terms of the GNU General Public License           *
 *   version 3 as published by the Free Software Foundation.               *
 *                                                                         *
 *   The conexus library is distributed in the hope that it will be        *
 *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty   *
 *   of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU   *
 *   General Public License for more details.                              *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this software. If not see <http://www.gnu.org/licenses/>.  *
 ***************************************************************************/
#ifndef CONEXUSENUMS_H
#define CONEXUSENUMS_H

#include <netinet/ip.h>
#include <termios.h>

namespace Conexus {

  typedef enum ReadWrite {
    READ_WRITE_NONE=0,
    READ=1,
    WRITE=2,
    READ_WRITE=3,
    READ_WRITE_UNCHANGED=4,
    READ_WRITE_LAST_STATE=READ_WRITE_UNCHANGED
  } ReadWrite;

  typedef enum EndpointState {
    ENDPOINT_NOSTATE   = 0,
    ENDPOINT_CLOSED    = 1<<0,    
    ENDPOINT_OPENED    = 1<<1,   
    ENDPOINT_LAST_STATE  = ENDPOINT_OPENED,
    ENDPOINT_UNCHANGED = ~0, 
  } EndpointState;

  typedef enum StartStop {
    STOP=0, 
    START=1,
  } StartStop;
  
  typedef enum SocketState {
    SOCKET_BOUND     = ENDPOINT_LAST_STATE << 1,  
    SOCKET_CONNECTED = ENDPOINT_LAST_STATE << 2,  
    SOCKET_LISTENING = ENDPOINT_LAST_STATE << 3,  
    SOCKET_ACCEPTED  = ENDPOINT_LAST_STATE << 4,  
    SOCKET_LAST_STATE  = SOCKET_ACCEPTED,
  } SocketState;

  typedef enum PipeMode {
    PIPE_READ=ENDPOINT_LAST_STATE<<1,           
    PIPE_WRITE=ENDPOINT_LAST_STATE<<2,            
  } PipeMode;

  typedef enum FileMode {
    FILE_READ=1<<0,
    FILE_WRITE=1<<1,
    FILE_APPEND=1<<2,
    FILE_CREATE=1<<3,
    FILE_DIRECT=1<<4,
    FILE_LARGE_FILE=1<<5,
    FILE_NO_ACCESS_TIME=1<<6,
    FILE_NO_FOLLOW=1<<7,
    FILE_TRUNCATE=1<<8,
    FILE_EXCLUSIVE_CREATE=1<<9,
    FILE_UNCHANGED=1<<10,
    FILE_LAST_STATE=FILE_UNCHANGED,
  } FileMode;

  typedef enum QueueMode {
    QUEUE_READ=1<<0,
    QUEUE_WRITE=1<<1,
    QUEUE_CREATE=1<<2,
    QUEUE_EXCLUSIVE_CREATE=1<<3,
    QUEUE_NONBLOCKING=1<<4,
    QUEUE_UNCHANGED=1<<5,
  } QueueMode;

  typedef enum TOS {
    TOS_LOWDELAY = IPTOS_LOWDELAY,       
    TOS_THROUGHPUT = IPTOS_THROUGHPUT,   
    TOS_RELIABILITY = IPTOS_RELIABILITY, 
    TOS_LOWCOST = IPTOS_LOWCOST,         
  } TOS;

  typedef enum SetOption {
    SET_NOW = TCSANOW,

    SET_FLUSH = TCSAFLUSH,

    SET_DRAIN = TCSADRAIN
  } SetOption;

  typedef enum Parity {
    PARITY_NONE,  
    PARITY_ODD,   
    PARITY_EVEN,  
  } Parity;

  typedef enum ParityError {
    PARITY_ERROR_DISCARD,  
    PARITY_ERROR_MARK,     
    PARITY_ERROR_ZERO,     
    PARITY_ERROR_IGNORE,   
  } ParityError;

  typedef enum FlowControl {
    FLOW_NONE,  
    FLOW_HARDWARE,  
    FLOW_SOFTWARE,  
    FLOW_CUSTOM,  
  } FlowControl;

}

#endif