C:/knet/include/kNet/Event.h

Go to the documentation of this file.

/* Copyright 2010 Jukka Jylänki

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License. */
#pragma once

#ifdef WIN32
#include "win32/WS2Include.h"
#endif

namespace kNet
{

enum EventWaitType
{
   EventWaitDummy, 
   EventWaitSignal, 
   EventWaitRead, 
   EventWaitWrite 
};


class Event
{
public:
   Event();
   // Does not delete the event. Call Event::Close() when you don't need it anymore.
// ~Event();

   void Create(EventWaitType type);

   void Close();

   bool IsNull() const;

   bool IsValid() const;

   void Reset();

   void Set();

   bool Test() const;

   bool Wait(unsigned long msecs) const;

   EventWaitType Type() const { return type; }

private:
   EventWaitType type;

#ifdef WIN32
public:
   WSAEVENT wsaEvent;

   explicit Event(WSAEVENT wsaEvent, EventWaitType eventType);
#elif LINUX
public:
   int fd;

   explicit Event(int /*SOCKET*/ fd, EventWaitType eventType);

#endif
};

Event CreateNewEvent(EventWaitType type);

} // ~kNet