pipe.h File Reference

#include <stdint.h>
#include <list.h>
#include <Fs\vfs.h>

Include dependency graph for pipe.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_pipe_

Typedefs
typedef struct _pipe_	AuPipe

Functions
size_t	AuPipeUnread (AuPipe *pipe)
	AuPipeUnread – get the available read space from the pipe.
int	AuCreatePipe (char *name, size_t sz)
	AuCreatePipe – creates a new pipe.
int	AuPipeFSAddFile (AuVFSNode *fs, char *path, AuVFSNode *file)
	AuPipeFSAddFile – adds a file/directory.
void	AuPipeFSInitialise ()
	AuPipeFSInitialise – initialise the pipe filesystem.

Typedef Documentation

AuPipe

typedef struct _pipe_ AuPipe

BSD 2-Clause License

Copyright (c) 2022-2023, Manas Kamal Choudhury All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. 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.

Function Documentation

AuCreatePipe()

int AuCreatePipe ( char *  name, size_t  sz  )

extern

AuCreatePipe – creates a new pipe.

Parameters

name	– name of the pipe
sz	– Size of the pipe

AuPipeFSAddFile()

int AuPipeFSAddFile ( AuVFSNode *  fs, char *  path, AuVFSNode *  file  )

extern

AuPipeFSAddFile – adds a file/directory.

Parameters

fs	– pointer to device file system
path	– path of the file
file	– file to add to dev fs

Returns

0 on success -1 failure

Parameters

fs	– pointer to device file system
path	– path of the file
file	– file to add to dev fs

AuPipeFSInitialise()

void AuPipeFSInitialise ( )

extern

AuPipeFSInitialise – initialise the pipe filesystem.

AuPipeUnread()

size_t AuPipeUnread ( AuPipe *  pipe )

extern

AuPipeUnread – get the available read space from the pipe.

Parameters

pipe	– Pointer to the pipe