command.h

Go to the documentation of this file.

#pragma once
 
 
#include "connect.h"
#include "context.h"
#include "future.h"
#include "nodiscard.h"
#include "pointer.h"
#include "result.h"
#include "visibility.h"
 
#include <assert.h>
 
 
// TODO: document and implement
//
// TODO: Explain somewhere that a udipe connection is mostly like a POSIX socket
//       but may be implemented using multiple sockets under the hood.
UDIPE_NODISCARD
UDIPE_NON_NULL_ARGS
UDIPE_NON_NULL_RESULT
UDIPE_PUBLIC
udipe_future_t* udipe_start_connect(udipe_context_t* context,
                                    udipe_connect_options_t options);
 
// TODO: document
UDIPE_NODISCARD
UDIPE_NON_NULL_ARGS
UDIPE_PUBLIC
udipe_connect_result_t udipe_connect(udipe_context_t* context,
                                     udipe_connect_options_t options);
 
// TODO: document and implement
UDIPE_NODISCARD
UDIPE_NON_NULL_ARGS
UDIPE_NON_NULL_RESULT
UDIPE_PUBLIC
udipe_future_t* udipe_start_disconnect(udipe_context_t* context,
                                       udipe_disconnect_options_t options);
 
// TODO: document
UDIPE_NODISCARD
UDIPE_NON_NULL_ARGS
UDIPE_PUBLIC
udipe_disconnect_result_t udipe_disconnect(udipe_context_t* context,
                                           udipe_disconnect_options_t options);
 
// TODO: Add and implement
/* // TODO: document and implement
//
// TODO: Should have GSO-like semantics, i.e. if you give a large enough buffer
//       then multiple datagrams may be sent. If GSO is disabled, then it just
//       sends a single datagram. Do not attempt to send more than 64 datagrams.
UDIPE_NODISCARD
UDIPE_NON_NULL_ARGS
UDIPE_NON_NULL_RESULT
UDIPE_PUBLIC
udipe_future_t* udipe_start_send(udipe_context_t* context,
                                 udipe_send_options_t options);
 
// TODO: document
UDIPE_NODISCARD
UDIPE_NON_NULL_ARGS
UDIPE_PUBLIC
udipe_send_result_t udipe_send(udipe_context_t* context,
                               udipe_send_options_t options);
 
// TODO: document and implement
UDIPE_NODISCARD
UDIPE_NON_NULL_ARGS
UDIPE_NON_NULL_RESULT
UDIPE_PUBLIC
udipe_future_t* udipe_start_recv(udipe_context_t* context,
                                 udipe_recv_options_t options);
 
// TODO: document
//
// TODO: Should have GRO-like semantics, i.e. if you give a large enough buffer
//       then multiple datagrams may be received, and there will be anciliary
//       data telling you how large the inner segments are. If GRO is disabled,
//       then it just receives a single datagram.
UDIPE_NODISCARD
UDIPE_NON_NULL_ARGS
UDIPE_PUBLIC
udipe_recv_result_t udipe_recv(udipe_context_t* context,
                               udipe_recv_options_t options); */