gPTP Documentation
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
WinNPipeCtrlMessage Class Reference

#include <ipcdef.hpp>

Inheritance diagram for WinNPipeCtrlMessage:
Inheritance graph
Collaboration diagram for WinNPipeCtrlMessage:
Collaboration graph

Public Member Functions

void init ()
 Initializes interace's internal variables. More...
 
void init (CtrlWhich which, PeerAddr addr)
 Initializes Interface's internal variables and sets control and addresses values. More...
 
PeerAddr getPeerAddr ()
 Gets peer addresses. More...
 
void setPeerAddr (PeerAddr addr)
 Sets peer address. More...
 
CtrlWhich getCtrlWhich ()
 Gets control type. More...
 
void setCtrlWhich (CtrlWhich which)
 Sets control message type. More...
 
uint16_t getFlags ()
 Gets internal flags. More...
 
- Public Member Functions inherited from WindowsNPipeMessage
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...
 

Additional Inherited Members

- Protected Attributes inherited from WindowsNPipeMessage
DWORD sz
 
NPIPE_MSG_TYPE type
 
OVERLAPPED ol_read
 
DWORD ol_read_req
 

Detailed Description

Provides an interface for named pipe control messages

Member Function Documentation

CtrlWhich WinNPipeCtrlMessage::getCtrlWhich ( )
inline

Gets control type.

Returns
CtrlWhich type
uint16_t WinNPipeCtrlMessage::getFlags ( )
inline

Gets internal flags.

Returns
Internal flags
Todo:
What are these flags used for? Apparently its not in use.
PeerAddr WinNPipeCtrlMessage::getPeerAddr ( )
inline

Gets peer addresses.

Returns
PeerAddr structure
void WinNPipeCtrlMessage::init ( )
inline

Initializes interace's internal variables.

Returns
void
void WinNPipeCtrlMessage::init ( CtrlWhich  which,
PeerAddr  addr 
)
inline

Initializes Interface's internal variables and sets control and addresses values.

Parameters
whichCtrlWhich enumeration
addrPeer addresses
Returns
void
void WinNPipeCtrlMessage::setCtrlWhich ( CtrlWhich  which)
inline

Sets control message type.

Parameters
whichCtrlWhich message
Returns
void
void WinNPipeCtrlMessage::setPeerAddr ( PeerAddr  addr)
inline

Sets peer address.

Parameters
addrPeerAddr to set
Returns
void

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