Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
Pipe.cxx File Reference
#include <sys/select.h>
#include <unistd.h>
#include <fcntl.h>
#include "Devtab.hxx"
#include "utils/constants.hxx"
#include "utils/RingBuffer.hxx"

Go to the source code of this file.

Classes

class  Pipe
 Private data for a can device. More...
 

Functions

int pipe (int pipefds[2])
 Create a Unix style pipe.
 

Variables

const size_t DEFAULT_PIPE_SIZE = 256
 Default value of the buffer size in the pipe implementation for FreeRTOS.
 

Detailed Description

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.

This file implements POSIX pipe().

Author
Stuart W. Baker
Date
27 January 2015

Definition in file Pipe.cxx.

Function Documentation

◆ pipe()

int pipe ( int  pipefds[2])

Create a Unix style pipe.

Parameters
pipefdsindex 0, file descriptor open for reading. index 1, file descriptor open for writing.
Returns
0 upon success, -1 on errer with errno set appropriately

Definition at line 391 of file Pipe.cxx.

Variable Documentation

◆ DEFAULT_PIPE_SIZE

const size_t DEFAULT_PIPE_SIZE = 256

Default value of the buffer size in the pipe implementation for FreeRTOS.

Definition at line 43 of file Pipe.cxx.