cat-rs 0.0.9

cat client with rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

/*
 * Copyright (c) 2011-2018, Meituan Dianping. All Rights Reserved.
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#ifndef CAT_CLIENT_C_STATIC_QUEUE_H
#define CAT_CLIENT_C_STATIC_QUEUE_H

#ifdef __cplusplus
extern "C" {
#endif

#include <string.h>
#include <stdlib.h>
#include <stddef.h>

#ifdef WIN32
#define inline __inline
#endif

typedef struct _CATStaticQueue {
    size_t maxQueueSize;
    volatile int head;
    volatile int tail;
    volatile size_t size;
    void *valueArray[];
} CATStaticQueue;

#define CATSTATICQUEUE_ERR -1
#define CATSTATICQUEUE_OK 0

CATStaticQueue *createCATStaticQueue(size_t maxQueueSize);

int pushBackCATStaticQueue(CATStaticQueue *pQueue, void *pData);

int pushFrontCATStaticQueue(CATStaticQueue *pQueue, void *pData);

void *popBackCATStaticQueue(CATStaticQueue *pQueue);

void *popFrontCATStaticQueue(CATStaticQueue *pQueue);

void *pryBackCATStaticQueue(CATStaticQueue *pQueue);

void *pryFrontCATStaticQueue(CATStaticQueue *pQueue);

void *getCATStaticQueueByIndex(CATStaticQueue *pQueue, size_t index);

void clearCATStaticQueue(CATStaticQueue *pQueue);

void destroyCATStaticQueue(CATStaticQueue *pQueue);

static inline size_t getCATStaticQueueSize(CATStaticQueue *pQueue) {
    return pQueue->size;
}

static inline int isCATStaticQueueEmpty(CATStaticQueue *pQueue) {
    return !pQueue->size;
}

static inline int isCATStaticQueueFull(CATStaticQueue *pQueue) {
    return !(pQueue->maxQueueSize - pQueue->size);
}

static inline int getCATStaticQueueRightDirect(CATStaticQueue *pQueue) {
    return pQueue->head - pQueue->tail;
}

typedef CATStaticQueue CATStaticStack;

#define createCATStaticStack createCATStaticQueue
#define pushCATStaticStack pushFrontCATStaticQueue
#define popCATStaticStack popFrontCATStaticQueue
#define peekCATStaticStack pryFrontCATStaticQueue
#define getCATStaticStackSize getCATStaticQueueSize
#define isCATStaticStackEmpty isCATStaticQueueEmpty
#define isCATStaticStackFull isCATStaticQueueFull
#define getCATStaticStackByIndex getCATStaticQueueByIndex
#define clearCATStaticStack clearCATStaticQueue
#define destroyCATStaticStack destroyCATStaticQueue

typedef CATStaticQueue CATStaticFIFOQueue;

#define createCATStaticFIFOQueue createCATStaticQueue
#define pushCATStaticFIFOQueue pushBackCATStaticQueue
#define popCATStaticFIFOQueue popFrontCATStaticQueue
#define peekCATStaticFIFOQueue pryFrontCATStaticQueue
#define getCATStaticFIFOQueueSize getCATStaticQueueSize
#define isCATStaticFIFOQueueEmpty isCATStaticQueueEmpty
#define isCATStaticFIFOQueueFull isCATStaticQueueFull
#define getCATStaticFIFOQueueByIndex getCATStaticQueueByIndex
#define clearCATStaticFIFOQueue clearCATStaticQueue
#define destroyCATStaticFIFOQueue destroyCATStaticQueue

#ifdef __cplusplus
}
#endif

#endif //CAT_CLIENT_C_STATIC_QUEUE_H