SocketClientServer.h

Go to the documentation of this file.

 
//
// Notice
// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
//
// NVIDIA CORPORATION & AFFILIATES assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA CORPORATION & AFFILIATES. No third party distribution is allowed unless
// expressly authorized by NVIDIA. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA CORPORATION & AFFILIATES products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA CORPORATION & AFFILIATES.
//
// SPDX-FileCopyrightText: Copyright (c) 2016-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
//
// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
// property and proprietary rights in and to this material, related
// documentation and any modifications thereto. Any use, reproduction,
// disclosure or distribution of this material and related documentation
// without an express license agreement from NVIDIA CORPORATION or
// its affiliates is strictly prohibited.
//
 
#ifndef DW_IPC_SOCKETCLIENTSERVER_H_
#define DW_IPC_SOCKETCLIENTSERVER_H_
 
#include <dw/core/base/Config.h>
#include <dw/core/context/Context.h>
#include <dw/core/base/Exports.h>
#include <dw/core/base/Status.h>
#include <dw/core/base/Types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct dwSocketServerObject* dwSocketServerHandle_t;
 
typedef struct dwSocketClientObject* dwSocketClientHandle_t;
 
typedef struct dwSocketConnectionObject* dwSocketConnectionHandle_t;
 
DW_API_PUBLIC
dwStatus dwSocketServer_initialize(dwSocketServerHandle_t* const server, uint16_t const port, size_t const connectionPoolSize,
                                   dwConstContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwSocketServer_accept(dwSocketConnectionHandle_t* const connection, dwTime_t const timeoutUs,
                               dwSocketServerHandle_t const server);
 
DW_API_PUBLIC
dwStatus dwSocketServer_broadcast(uint8_t const* const buffer, size_t const bufferSize, dwSocketServerHandle_t const server);
 
DW_API_PUBLIC
dwStatus dwSocketServer_release(dwSocketServerHandle_t const server);
 
DW_API_PUBLIC
dwStatus dwSocketClient_initialize(dwSocketClientHandle_t* const client, size_t const connectionPoolSize,
                                   dwConstContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwSocketClient_connect(dwSocketConnectionHandle_t* const connection, char8_t const* const host, uint16_t const port,
                                dwTime_t const timeoutUs, dwSocketClientHandle_t const client);
 
DW_API_PUBLIC
dwStatus dwSocketClient_broadcast(uint8_t const* const buffer, size_t const bufferSize, dwSocketClientHandle_t const client);
 
DW_API_PUBLIC
dwStatus dwSocketClient_release(dwSocketClientHandle_t const client);
 
DW_API_PUBLIC
dwStatus dwSocketConnection_write(const void* const buffer, size_t* const bufferSize, dwTime_t const timeoutUs,
                                  dwSocketConnectionHandle_t const connection);
 
DW_API_PUBLIC
dwStatus dwSocketConnection_peek(uint8_t* const buffer, size_t* const bufferSize,
                                 dwTime_t const timeoutUs,
                                 dwSocketConnectionHandle_t const connection);
 
DW_API_PUBLIC
dwStatus dwSocketConnection_read(void* const buffer, size_t* const bufferSize, dwTime_t const timeoutUs, dwSocketConnectionHandle_t const connection);
 
DW_API_PUBLIC
dwStatus dwSocketConnection_release(dwSocketConnectionHandle_t const connection);
 
#ifdef __cplusplus
}
#endif
 
#endif // DW_IPC_SOCKETCLIENTSERVER_H_