sockbuf.h

00001 /*
00002  * Copyright (c) 2016-2017, Arm Limited and affiliates.
00003  * SPDX-License-Identifier: Apache-2.0
00004  *
00005  * Licensed under the Apache License, Version 2.0 (the "License");
00006  * you may not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  *     http://www.apache.org/licenses/LICENSE-2.0
00010  *
00011  * Unless required by applicable law or agreed to in writing, software
00012  * distributed under the License is distributed on an "AS IS" BASIS,
00013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  * See the License for the specific language governing permissions and
00015  * limitations under the License.
00016  */
00017 
00018 #ifndef SOCKBUF_H_
00019 #define SOCKBUF_H_
00020 
00021 #include "Core/include/ns_buffer.h"
00022 
00023 typedef struct sockbuf {
00024     uint32_t   data_bytes;
00025     uint32_t   data_byte_limit;
00026     uint32_t   buf_overhead_bytes;
00027     uint32_t   buf_overhead_byte_limit;
00028     uint32_t   low_water_mark;
00029     buffer_list_t bufs;
00030 } sockbuf_t;
00031 
00032 void sockbuf_init(sockbuf_t *sb);
00033 void sockbuf_append(sockbuf_t *sb, buffer_t *buf);
00034 void sockbuf_append_and_compress(sockbuf_t *sb, buffer_t *buf);
00035 void sockbuf_alloc(sockbuf_t *sb, const buffer_t *buf);
00036 void sockbuf_free(sockbuf_t *sb, const buffer_t *buf);
00037 void sockbuf_drop(sockbuf_t *sb, uint32_t len);
00038 void sockbuf_drop_first(sockbuf_t *sb);
00039 void sockbuf_flush(sockbuf_t *sb);
00040 bool sockbuf_reserve(sockbuf_t *sb, uint32_t space);
00041 int32_t sockbuf_space(const sockbuf_t *sb);
00042 void sockbuf_check(sockbuf_t *sb);
00043 
00044 #endif /* SOCKBUF_H_ */