1085df54ed
build files and documentation: MIT images / sources: GPL-2.0-only breeze icons: LGPL-2.0-only Microsoft MSM file, vc redist license
67 lines
1.8 KiB
C++
67 lines
1.8 KiB
C++
/*
|
|
* Deskflow -- mouse and keyboard sharing utility
|
|
* SPDX-FileCopyrightText: (C) 2012 - 2016 Symless Ltd.
|
|
* SPDX-FileCopyrightText: (C) 2004 Chris Schoeneman
|
|
* SPDX-License-Identifier: GPL-2.0-only WITH LicenseRef-OpenSSL-Exception
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "base/EventTypes.h"
|
|
#include "io/IStream.h"
|
|
#include "net/ISocket.h"
|
|
|
|
//! Data stream socket interface
|
|
/*!
|
|
This interface defines the methods common to all network sockets that
|
|
represent a full-duplex data stream.
|
|
*/
|
|
class IDataSocket : public ISocket, public deskflow::IStream
|
|
{
|
|
public:
|
|
class ConnectionFailedInfo
|
|
{
|
|
public:
|
|
ConnectionFailedInfo(const char *what) : m_what(what)
|
|
{
|
|
}
|
|
std::string m_what;
|
|
};
|
|
|
|
IDataSocket(IEventQueue *events)
|
|
{
|
|
}
|
|
|
|
//! @name manipulators
|
|
//@{
|
|
|
|
//! Connect socket
|
|
/*!
|
|
Attempt to connect to a remote endpoint. This returns immediately
|
|
and sends a connected event when successful or a connection failed
|
|
event when it fails. The stream acts as if shutdown for input and
|
|
output until the stream connects.
|
|
*/
|
|
virtual void connect(const NetworkAddress &) = 0;
|
|
|
|
//@}
|
|
|
|
// ISocket overrides
|
|
// close() and getEventTarget() aren't pure to work around a bug
|
|
// in VC++6. it claims the methods are unused locals and warns
|
|
// that it's removing them. it's presumably tickled by inheriting
|
|
// methods with identical signatures from both superclasses.
|
|
virtual void bind(const NetworkAddress &) = 0;
|
|
virtual void close();
|
|
virtual void *getEventTarget() const;
|
|
|
|
// IStream overrides
|
|
virtual uint32_t read(void *buffer, uint32_t n) = 0;
|
|
virtual void write(const void *buffer, uint32_t n) = 0;
|
|
virtual void flush() = 0;
|
|
virtual void shutdownInput() = 0;
|
|
virtual void shutdownOutput() = 0;
|
|
virtual bool isReady() const = 0;
|
|
virtual bool isFatal() const = 0;
|
|
virtual uint32_t getSize() const = 0;
|
|
};
|