YARP
Yet Another Robot Platform
NameserCarrier.h
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
3 * SPDX-FileCopyrightText: 2006-2010 RobotCub Consortium
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7#ifndef YARP_OS_IMPL_NAMESERCARRIER_H
8#define YARP_OS_IMPL_NAMESERCARRIER_H
9
12
13
14namespace yarp::os::impl {
15
22 public TwoWayStream,
24{
25private:
26 TwoWayStream* delegate;
27 std::string pendingRead;
28 std::string swallowRead;
29
30public:
32
33 virtual ~NameserTwoWayStream();
34
35 InputStream& getInputStream() override;
36 OutputStream& getOutputStream() override;
37 const Contact& getLocalAddress() const override;
38 const Contact& getRemoteAddress() const override;
39
40 bool isOk() const override;
41 void reset() override;
42 void close() override;
43 void beginPacket() override;
44 void endPacket() override;
45
48};
49
50
57 public TcpCarrier
58{
59private:
60 bool firstSend;
61
62public:
64
65 std::string getName() const override;
66 std::string getSpecifierName() const;
67
68 Carrier* create() const override;
69
70 bool checkHeader(const Bytes& header) override;
71 void getHeader(Bytes& header) const override;
72 bool requireAck() const override;
73 bool isTextMode() const override;
74 bool supportReply() const override;
75 bool canEscape() const override;
76 bool sendHeader(ConnectionState& proto) override;
77 bool expectSenderSpecifier(ConnectionState& proto) override;
78 bool expectIndex(ConnectionState& proto) override;
79 bool sendAck(ConnectionState& proto) override;
80 bool expectAck(ConnectionState& proto) override;
81 bool respondToHeader(ConnectionState& proto) override;
82 bool expectReplyToHeader(ConnectionState& proto) override;
83 bool write(ConnectionState& proto, SizedWriter& writer) override;
84};
85
86} // namespace yarp::os::impl
87
88#endif // YARP_OS_IMPL_NAMESERCARRIER_H
A simple abstraction for a block of bytes.
Definition: Bytes.h:24
A base class for connection types (tcp, mcast, shmem, ...) which are called carriers in YARP.
Definition: Carrier.h:44
The basic state of a connection - route, streams in use, etc.
Represents how to reach a part of a YARP network.
Definition: Contact.h:33
Simple specification of the minimum functions needed from input streams.
Definition: InputStream.h:25
virtual int read()
Read and return a single byte.
Definition: InputStream.cpp:20
Simple specification of the minimum functions needed from output streams.
Definition: OutputStream.h:21
Minimal requirements for an efficient Writer.
Definition: SizedWriter.h:32
A stream which can be asked to perform bidirectional communication.
Definition: TwoWayStream.h:25
Communicating between two ports via a variant plain-text protocol originally designed for the yarp na...
bool write(ConnectionState &proto, SizedWriter &writer) override
Write a message.
bool canEscape() const override
Check if carrier can encode administrative messages, as opposed to just user data.
bool respondToHeader(ConnectionState &proto) override
Respond to the header.
bool requireAck() const override
Check if carrier has flow control, requiring sent messages to be acknowledged by recipient.
std::string getName() const override
Get the name of this connection type ("tcp", "mcast", "shmem", ...)
bool sendHeader(ConnectionState &proto) override
Write a header appropriate to the carrier to the connection, followed by any carrier-specific data.
void getHeader(Bytes &header) const override
Provide 8 bytes describing this connection sufficiently to allow the other side of a connection to se...
Carrier * create() const override
Factory method.
bool expectReplyToHeader(ConnectionState &proto) override
Process reply to header, if one is expected for this carrier.
bool expectIndex(ConnectionState &proto) override
Expect a message header, if there is one for this carrier.
bool expectSenderSpecifier(ConnectionState &proto) override
Expect the name of the sending port.
bool checkHeader(const Bytes &header) override
Given the first 8 bytes received on a connection, decide if this is the right carrier type to use for...
bool sendAck(ConnectionState &proto) override
Send an acknowledgement, if needed for this carrier.
bool supportReply() const override
This flag is used by YARP to determine whether the connection can carry RPC traffic,...
std::string getSpecifierName() const
bool expectAck(ConnectionState &proto) override
Receive an acknowledgement, if expected for this carrier.
bool isTextMode() const override
Check if carrier is textual in nature.
Communicating between two ports via a variant plain-text protocol originally designed for the yarp na...
void reset() override
Reset the stream.
const Contact & getLocalAddress() const override
Get the address of the local side of the stream.
OutputStream & getOutputStream() override
Get an OutputStream to write to.
InputStream & getInputStream() override
Get an InputStream to read from.
NameserTwoWayStream(TwoWayStream *delegate)
void endPacket() override
Mark the end of a logical packet (see beginPacket).
bool isOk() const override
Check if the stream is ok or in an error state.
void close() override
Terminate the stream.
void beginPacket() override
Mark the beginning of a logical packet.
const Contact & getRemoteAddress() const override
Get the address of the remote side of the stream.
Communicating between two ports via TCP.
Definition: TcpCarrier.h:19
::ssize_t ssize_t
Definition: numeric.h:86
The components from which ports and connections are built.