Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Related Pages

# ACE_Pipe Class Reference

Provides a bidirectional "pipe" abstraction that is portable to Windows NT, SVR4 UNIX, and BSD UNIX. More...

`#include <Pipe.h>`

List of all members.

## Public Methods
| ACE_Pipe (void)
| Default constructor (does nothing...). More...
| ACE_Pipe (ACE_HANDLE handles[2])
| Open the pipe and initialize the handles. More...
| ACE_Pipe (ACE_HANDLE read, ACE_HANDLE write)
| Initialize the <ACE_Pipe> from the <read> and <write> handles. More...
| ~ACE_Pipe (void)
| Default dtor. It doesn't close the handles for you. More...
int | open (ACE_HANDLE handles[2])
| Open the pipe and initialize the handles. More...
int | open (int buffer_size=ACE_DEFAULT_MAX_SOCKET_BUFSIZ)
| Open the pipe, setting the buffer size to the maximum. More...
int | close (void)
| Close down the pipe HANDLEs;. More...
ACE_HANDLE | read_handle (void) const
| This is the "read" side of the pipe. More...
ACE_HANDLE | write_handle (void) const
| This is the "write" side of the pipe. More...
void | dump (void) const
| Dump the state of the object. More...
## Private Attributes
ACE_HANDLE | handles_ [2]

## Detailed Description

Provides a bidirectional "pipe" abstraction that is portable to Windows NT, SVR4 UNIX, and BSD UNIX.

Uses "name" for lookup in the ACE service repository. Obtains the object and returns it as the appropriate type.

## Constructor & Destructor Documentation

ACE_Pipe::ACE_Pipe | ( | void |  | ) |

| Default constructor (does nothing...).

ACE_Pipe::ACE_Pipe | ( | ACE_HANDLE | handles[2] | ) |

| Open the pipe and initialize the handles.

ACE_Pipe::ACE_Pipe | ( | ACE_HANDLE | read,
|  | ACE_HANDLE | write
| ) |

| Initialize the <ACE_Pipe> from the <read> and <write> handles.

ASYS_INLINE ACE_Pipe::~ACE_Pipe | ( | void |  | ) |

| Default dtor. It doesn't close the handles for you.

## Member Function Documentation

int ACE_Pipe::close | ( | void |  | ) |

| Close down the pipe HANDLEs;.

void ACE_Pipe::dump | ( | void |  | ) | const

| Dump the state of the object.

int ACE_Pipe::open | ( | int | buffer_size = ACE_DEFAULT_MAX_SOCKET_BUFSIZ | ) |

| Open the pipe, setting the buffer size to the maximum.

int ACE_Pipe::open | ( | ACE_HANDLE | handles[2] | ) |

| Open the pipe and initialize the handles.

ASYS_INLINE ACE_HANDLE ACE_Pipe::read_handle | ( | void |  | ) | const

| This is the "read" side of the pipe. Note, however, that processes can also write to this handle as well since pipes are bi-directional.

ASYS_INLINE ACE_HANDLE ACE_Pipe::write_handle | ( | void |  | ) | const

| This is the "write" side of the pipe. Note, however, that processes can also read to this handle as well since pipes are bi-directional.

## Member Data Documentation

ACE_HANDLE ACE_Pipe::handles_[2]`[private]`

The documentation for this class was generated from the following files:

- Pipe.h
- Pipe.cpp
- Pipe.i