WindowsNPipeMessage Class Reference

#include <ipcdef.hpp>

Inheritance diagram for WindowsNPipeMessage:

Collaboration diagram for WindowsNPipeMessage:

Public Member Functions
void	init ()
	Initializes the interface. More...
bool	write (HANDLE pipe)
	Writes to the named pipe. More...
long	read_ol (HANDLE pipe, long offs, HANDLE event)
	Reads from the pipe. More...
long	read_ol_complete (HANDLE pipe)
	Reads completely the overlapped result. More...
long	read (HANDLE pipe, long offs)
	Reads from the pipe. More...
NPIPE_MSG_TYPE	getType ()
	Gets pipe message type. More...

Protected Attributes
DWORD	sz
NPIPE_MSG_TYPE	type
OVERLAPPED	ol_read
DWORD	ol_read_req

Detailed Description

Provides a windows named pipe interface

Member Function Documentation

NPIPE_MSG_TYPE WindowsNPipeMessage::getType ( )

inline

Gets pipe message type.

Returns

NPIPE_MSG_TYPE

void WindowsNPipeMessage::init ( )

inline

Initializes the interface.

Returns

void

long WindowsNPipeMessage::read ( HANDLE  pipe, long  offs  )

inline

Reads from the pipe.

Parameters

pipe	Pipe handler
offs	base offset

Returns

-1 if error, 0 if ERROR_IO_PENDING or bytes_read + offs

long WindowsNPipeMessage::read_ol ( HANDLE  pipe, long  offs, HANDLE  event  )

inline

Reads from the pipe.

Parameters

pipe	Pipe handle
offs	base offset
event	Event handler

Returns

-1 if error, 0 if ERROR_IO_PENDING or bytes_read + offs

long WindowsNPipeMessage::read_ol_complete ( HANDLE  pipe )

inline

Reads completely the overlapped result.

Parameters

pipe	Pipe handler

Returns

bytes read in case of success, -1 in case of error

Todo:

Its not clear what GetOverlappedResult does

bool WindowsNPipeMessage::write ( HANDLE  pipe )

inline

Writes to the named pipe.

Parameters

pipe	Pipe handler

Returns

TRUE in case of success, FALSE in case of error.

Member Data Documentation

OVERLAPPED WindowsNPipeMessage::ol_read

protected

Overlapped read

DWORD WindowsNPipeMessage::ol_read_req

protected

Overlapped read request

DWORD WindowsNPipeMessage::sz

protected

Size

NPIPE_MSG_TYPE WindowsNPipeMessage::type

protected

Message type as NPIPE_MSG_TYPE

---

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

• windows/daemon_cl/ipcdef.hpp