vpr::SelectorImplSIM Class Reference

Implementation of a selector for simulated sockets. More...

#include <vpr/IO/Selector.h>

Inheritance diagram for vpr::SelectorImplSIM:

[legend]Collaboration diagram for vpr::SelectorImplSIM:

[legend]List of all members.

Public Member Functions
bool	addHandle (vpr::IOSys::Handle handle, vpr::Uint16 mask=0)
	Adds the given handle to the selector.
bool	removeHandle (vpr::IOSys::Handle handle)
	Removes a handle from the selector.
bool	setIn (vpr::IOSys::Handle handle, vpr::Uint16 mask)
	Sets the event flags going in to the select to mask.
vpr::Uint16	getIn (vpr::IOSys::Handle handle)
	Gets the current in-flag mask.
vpr::Uint16	getOut (vpr::IOSys::Handle handle)
	Gets the current "out flag" mask after a call to select.
vpr::ReturnStatus	select (vpr::Uint16 &numWithEvents, const vpr::Interval timeout=vpr::Interval::NoTimeout)
	Poll for any ready events among the registered handles using their in flags.
vpr::Uint16	getNumHandles ()
	For iteration over the registered handles.
vpr::IOSys::Handle	getHandle (vpr::Uint16 index)
	Gets the handle at the given index within the collection of registered handles.
bool	containsHandle (vpr::IOSys::Handle handle)
	Tests if the selector contain the given handle.
Protected Member Functions
std::vector< SimPollDesc >::iterator	getHandle (vpr::IOSys::Handle handle)
	Gets the index of the handle given.
Protected Attributes
std::vector< SimPollDesc >	mPollDescs
	List of poll descriptors to pass to select.
Classes
struct	SimPollDesc
	Simple type used for the vector of poll descriptors. More...

---

Detailed Description

Implementation of a selector for simulated sockets.

This is typedef'd to vpr::Selector.

Implementation site of the vpr::Selector_t bridge.

Definition at line 65 of file SelectorImplSIM.h.

---

Member Function Documentation

bool vpr::SelectorImplSIM::addHandle	(	vpr::IOSys::Handle	handle,
		vpr::Uint16	mask = 0
	)

Adds the given handle to the selector.

Precondition:

handle is a valid handle.

handle is added to the handle set, and its mask is initialized using the given value.

Parameters:

	handle	The handle to be added to the selector's handle set.
	mask	The mask used when checking for ready events on the given handle. This argument is optional and defaults to 0 (no events).

Returns:

true is returned if the given handle is added successfully; false otherwise.

Definition at line 51 of file SelectorImplSIM.cpp.

References getHandle(), and mPollDescs.

{
   bool status;

   if ( getHandle(handle) == mPollDescs.end() )
   {
      SimPollDesc new_desc;
      new_desc.fd        = handle;
      new_desc.in_flags  = mask;
      new_desc.out_flags = 0;

      mPollDescs.push_back(new_desc);
      status = true;
   }
   else
   {
      status = false;
   }

   return status;
}

bool vpr::SelectorImplSIM::removeHandle

(

vpr::IOSys::Handle

handle

)

Removes a handle from the selector.

Precondition:

handle is in the selector.

Postcondition:

handle is removed from the set of valid handles.

Parameters:

handle

The handle to be removed from the selector's handle set.

Returns:

true is returned if the given handle is removed successfully; false otherwise.

Definition at line 73 of file SelectorImplSIM.cpp.

References getHandle(), and mPollDescs.

{
   bool status;
   std::vector<SimPollDesc>::iterator i = getHandle(handle);

   if ( mPollDescs.end() == i )
   {
      status = false;
   }
   else
   {
      mPollDescs.erase(i);
      status = true;
   }

   return status;
}

bool vpr::SelectorImplSIM::setIn	(	vpr::IOSys::Handle	handle,
		vpr::Uint16	mask
	)

Sets the event flags going in to the select to mask.

Precondition:

handle has already been registered with this selector.

Postcondition:

handle has its mask updated to use the given value.

Parameters:

	handle	The handle whose mask will be set.
	mask	The mask used when checking for ready events on the given handle.

Definition at line 91 of file SelectorImplSIM.cpp.

References getHandle(), and mPollDescs.

{
   bool status;
   std::vector<SimPollDesc>::iterator i = getHandle(handle);

   if ( mPollDescs.end() == i )
   {
      status = false;
   }
   else
   {
      (*i).in_flags = mask;
      status = true;
   }

   return status;
}

vpr::Uint16 vpr::SelectorImplSIM::getIn

(

vpr::IOSys::Handle

handle

)

Gets the current in-flag mask.

Precondition:

handle has already been added to the selector using addHandle.

Parameters:

handle

The handle whose "in" event flags will be returned.

Returns:

A bitmask value representing the "in flags" of handle.

Definition at line 109 of file SelectorImplSIM.cpp.

References getHandle(), and mPollDescs.

{
   vpr::Uint16 flags;
   std::vector<SimPollDesc>::iterator i = getHandle(handle);

   if ( mPollDescs.end() == i )
   {
      // XXX: This is VERY bad thing to do.  Need to have an error code instead
      flags = 0;
   }
   else
   {
      flags = (*i).in_flags;
   }

   return flags;
}

vpr::Uint16 vpr::SelectorImplSIM::getOut

(

vpr::IOSys::Handle

handle

)

Gets the current "out flag" mask after a call to select.

The value returned will be the bitwise OR of the "out flags". These state which of the operations named "in flags" were found to be ready.

Precondition:

select() has been called.

Parameters:

handle

The handle whose "out" event flags will be returned.

Returns:

A bitmask value representing the "out flags" of handle. These flags state which requested events were detected for handle.

Definition at line 127 of file SelectorImplSIM.cpp.

References getHandle(), and mPollDescs.

{
   vpr::Uint16 flags;
   std::vector<SimPollDesc>::iterator i = getHandle(handle);

   if ( mPollDescs.end() == i )
   {
      // XXX: This is VERY bad thing to do.  Need to have an error code instead
      flags = 0;
   }
   else
   {
      flags = (*i).out_flags;
   }

   return flags;
}

vpr::ReturnStatus vpr::SelectorImplSIM::select	(	vpr::Uint16 &	numWithEvents,
		const vpr::Interval	timeout = vpr::Interval::NoTimeout
	)

Poll for any ready events among the registered handles using their in flags.

Parameters:

	numWithEvents	Upon completion, this holds the number of items that have events.
	timeout	The interval to wait for an event to be raised. This argument is optional and defaults to vpr::Interval::NoTimeout (wait until an event is detected withotu timing out). Passing vpr::Interval::NoWait effects a poll on the registered handles and returns immediately.

Returns:

vpr::ReturnStatus::Success is returned if at least one event was detected within the timeout interval.

vpr::ReturnStatus::Timeout is returned if no events were detected before the timeout expired or if vpr::Interval::NoWait was passed. In this case, numWithEvents should be checked for a value greater than 0.

vpr::ReturnStatus::Failure is returned if the select failed.

Definition at line 145 of file SelectorImplSIM.cpp.

References vpr::SelectorBase::Accept, vpr::SelectorBase::Except, mPollDescs, vpr::SelectorBase::Read, vpr::ReturnStatus::setCode(), vpr::ReturnStatus::Timeout, and vpr::SelectorBase::Write.

{
   vpr::ReturnStatus status;
   std::vector<SimPollDesc>::iterator i;
   bool has_event;

   numWithEvents = 0;

   for ( i = mPollDescs.begin(); i != mPollDescs.end(); ++i )
   {
      // We have to do this every time to insure that a previous event is not
      // "reselected".
      (*i).out_flags = 0;

      has_event = false;

      if ( (*i).in_flags & vpr::SelectorBase::Read ||
           (*i).in_flags & vpr::SelectorBase::Accept)
      {
         if ( (*i).fd->isReadReady().success() )
         {
            has_event = true;
            (*i).out_flags |= vpr::SelectorBase::Read;
         }
      }

      if ( (*i).in_flags & vpr::SelectorBase::Write )
      {
         if ( (*i).fd->isWriteReady().success() )
         {
            has_event = true;
            (*i).out_flags |= vpr::SelectorBase::Write;
         }
      }

      if ( (*i).in_flags & vpr::SelectorBase::Except )
      {
         if ( (*i).fd->inExceptState().success() )
         {
            has_event = true;
            (*i).out_flags |= vpr::SelectorBase::Except;
         }
      }

      if ( has_event )
      {
         numWithEvents++;
      }
   }

   if ( numWithEvents == 0 )
   {
      status.setCode(vpr::ReturnStatus::Timeout);
   }

   return status;
}

vpr::Uint16 vpr::SelectorImplSIM::getNumHandles

(

)

[inline]

For iteration over the registered handles.

Returns:

An unsigned value stating how many handles have been registered.

Definition at line 166 of file SelectorImplSIM.h.

   {
      return mPollDescs.size();
   }

vpr::IOSys::Handle vpr::SelectorImplSIM::getHandle

(

vpr::Uint16

index

)

[inline]

Gets the handle at the given index within the collection of registered handles.

The index is determined by the order of handle addition using addHandle().

Parameters:

index

The index of the desired handle.

Returns:

A vpr::IOSys::Handle object representing the registered handle at the given index.

Definition at line 181 of file SelectorImplSIM.h.

Referenced by addHandle(), getIn(), getOut(), removeHandle(), and setIn().

   {
      return mPollDescs[index].fd;
   }

bool vpr::SelectorImplSIM::containsHandle

(

vpr::IOSys::Handle

handle

)

[inline]

Tests if the selector contain the given handle.

Parameters:

handle

The handle of interest.

Returns:

true is returned if handle was previously registered with this selector.

false is returned if the handle has not been registered.

Definition at line 195 of file SelectorImplSIM.h.

   {
      return (getHandle(handle) != mPollDescs.end());
   }

std::vector< SelectorImplSIM::SimPollDesc >::iterator vpr::SelectorImplSIM::getHandle

(

vpr::IOSys::Handle

handle

)

[protected]

Gets the index of the handle given.

Returns:

.end() is returned if the given index is not found.

Otherwise, the index to the handle in mPollDescs is returned.

Definition at line 205 of file SelectorImplSIM.cpp.

References mPollDescs.

{
   // XXX: Should probably be replaced by a map in the future for speed.

   for ( std::vector<SimPollDesc>::iterator i=mPollDescs.begin();
         i != mPollDescs.end();
         ++i )
   {
      if ( (*i).fd == handle )
      {
         return i;
      }
   }

   return mPollDescs.end();
}

---

Member Data Documentation

std::vector<SimPollDesc> vpr::SelectorImplSIM::mPollDescs [protected]

List of poll descriptors to pass to select.

Definition at line 218 of file SelectorImplSIM.h.

Referenced by addHandle(), getHandle(), getIn(), getOut(), removeHandle(), select(), and setIn().

---

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

• SelectorImplSIM.h
• SelectorImplSIM.cpp

---