acdc745689
The first line of the doc string ends up on the SB API class summary at the root page of the Python API web page of LLDB. Currently many of the descriptions are missing or are several lines which makes the table really hard to read. This just adds the missing docstrings where possible and fixes the formatting where necessary.
87 lines
2.3 KiB
C++
87 lines
2.3 KiB
C++
//===-- SWIG Interface for SBCommunication ----------------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
namespace lldb {
|
|
|
|
%feature("docstring",
|
|
"Allows sending/receiving data."
|
|
) SBCommunication;
|
|
class SBCommunication
|
|
{
|
|
public:
|
|
enum {
|
|
eBroadcastBitDisconnected = (1 << 0), ///< Sent when the communications connection is lost.
|
|
eBroadcastBitReadThreadGotBytes = (1 << 1), ///< Sent by the read thread when bytes become available.
|
|
eBroadcastBitReadThreadDidExit = (1 << 2), ///< Sent by the read thread when it exits to inform clients.
|
|
eBroadcastBitReadThreadShouldExit = (1 << 3), ///< Sent by clients that need to cancel the read thread.
|
|
eBroadcastBitPacketAvailable = (1 << 4), ///< Sent when data received makes a complete packet.
|
|
eAllEventBits = 0xffffffff
|
|
};
|
|
|
|
typedef void (*ReadThreadBytesReceived) (void *baton, const void *src, size_t src_len);
|
|
|
|
SBCommunication ();
|
|
SBCommunication (const char * broadcaster_name);
|
|
~SBCommunication ();
|
|
|
|
|
|
bool
|
|
IsValid () const;
|
|
|
|
explicit operator bool() const;
|
|
|
|
lldb::SBBroadcaster
|
|
GetBroadcaster ();
|
|
|
|
static const char *GetBroadcasterClass();
|
|
|
|
lldb::ConnectionStatus
|
|
AdoptFileDesriptor (int fd, bool owns_fd);
|
|
|
|
lldb::ConnectionStatus
|
|
Connect (const char *url);
|
|
|
|
lldb::ConnectionStatus
|
|
Disconnect ();
|
|
|
|
bool
|
|
IsConnected () const;
|
|
|
|
bool
|
|
GetCloseOnEOF ();
|
|
|
|
void
|
|
SetCloseOnEOF (bool b);
|
|
|
|
size_t
|
|
Read (void *dst,
|
|
size_t dst_len,
|
|
uint32_t timeout_usec,
|
|
lldb::ConnectionStatus &status);
|
|
|
|
size_t
|
|
Write (const void *src,
|
|
size_t src_len,
|
|
lldb::ConnectionStatus &status);
|
|
|
|
bool
|
|
ReadThreadStart ();
|
|
|
|
bool
|
|
ReadThreadStop ();
|
|
|
|
bool
|
|
ReadThreadIsRunning ();
|
|
|
|
bool
|
|
SetReadThreadBytesReceivedCallback (ReadThreadBytesReceived callback,
|
|
void *callback_baton);
|
|
};
|
|
|
|
} // namespace lldb
|