barrier/lib/net/ISocket.h

69 lines
1.5 KiB
C
Raw Normal View History

2002-08-02 19:57:46 +00:00
/*
* synergy -- mouse and keyboard sharing utility
* Copyright (C) 2002 Chris Schoeneman
*
* This package is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* found in the file COPYING that should have accompanied this file.
*
* This package is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
2001-10-06 14:13:28 +00:00
#ifndef ISOCKET_H
#define ISOCKET_H
#include "IInterface.h"
#include "CEvent.h"
2001-10-06 14:13:28 +00:00
class CNetworkAddress;
//! Generic socket interface
/*!
This interface defines the methods common to all network sockets.
*/
2001-10-06 14:13:28 +00:00
class ISocket : public IInterface {
2002-04-29 14:40:01 +00:00
public:
//! @name manipulators
//@{
2001-10-06 14:13:28 +00:00
//! Bind socket to address
/*!
Binds the socket to a particular address.
*/
virtual void bind(const CNetworkAddress&) = 0;
2001-10-06 14:13:28 +00:00
//! Close socket
/*!
Closes the socket. This should flush the output stream.
*/
virtual void close() = 0;
2001-10-06 14:13:28 +00:00
//! Set the socket's event target
/*!
Sets the target of any events sent by the socket. The default is NULL.
*/
virtual void setEventTarget(void*) = 0;
//@}
//! @name accessors
//@{
//! Get disconnected event type
/*!
Returns the socket disconnected event type. A socket sends this
event when the remote side of the socket has disconnected or
shutdown.
*/
static CEvent::Type getDisconnectedEvent();
//@}
private:
static CEvent::Type s_disconnectedEvent;
2001-10-06 14:13:28 +00:00
};
#endif