1 /***************************************************************************
2  * Copyright (c) 2024 Microsoft Corporation
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the MIT License which is available at
6  * https://opensource.org/licenses/MIT.
7  *
8  * SPDX-License-Identifier: MIT
9  **************************************************************************/
10 
11 
12 /**************************************************************************/
13 /**************************************************************************/
14 /**                                                                       */
15 /** POSIX wrapper for THREADX                                             */
16 /**                                                                       */
17 /**                                                                       */
18 /**                                                                       */
19 /**************************************************************************/
20 /**************************************************************************/
21 
22 /* Include necessary system files.  */
23 
24 #include "tx_api.h"     /* Threadx API */
25 #include "pthread.h"    /* Posix API */
26 #include "px_int.h"     /* Posix helper functions */
27 
28 
29 /**************************************************************************/
30 /*                                                                        */
31 /*  FUNCTION                                               RELEASE        */
32 /*                                                                        */
33 /*    posix_queue_delete                                  PORTABLE C      */
34 /*                                                           6.1.7        */
35 /*  AUTHOR                                                                */
36 /*                                                                        */
37 /*    William E. Lamie, Microsoft Corporation                             */
38 /*                                                                        */
39 /*  DESCRIPTION                                                           */
40 /*                                                                        */
41 /*    deletes a message queue                                             */
42 /*                                                                        */
43 /*  INPUT                                                                 */
44 /*                                                                        */
45 /*    q_ptr                         message queue pointer                 */
46 /*                                                                        */
47 /*  OUTPUT                                                                */
48 /*                                                                        */
49 /*    ERROR                         If fails                              */
50 /*    OK                            If successful                         */
51 /*                                                                        */
52 /*  CALLS                                                                 */
53 /*                                                                        */
54 /*    tx_queue_delete               Detectes a Queue                      */
55 /*    posix_internal_error          Generic error                         */
56 /*    posix_reset queue             Resets queue structure                */
57 /*                                                                        */
58 /*  CALLED BY                                                             */
59 /*                                                                        */
60 /*    POSIX internal Code                                                 */
61 /*                                                                        */
62 /*  RELEASE HISTORY                                                       */
63 /*                                                                        */
64 /*    DATE              NAME                      DESCRIPTION             */
65 /*                                                                        */
66 /*  06-02-2021     William E. Lamie         Initial Version 6.1.7         */
67 /*                                                                        */
68 /**************************************************************************/
posix_queue_delete(POSIX_MSG_QUEUE * q_ptr)69 INT posix_queue_delete(POSIX_MSG_QUEUE  * q_ptr)
70 {
71 
72 TX_QUEUE          *queue;
73 
74     queue = &(q_ptr->queue);
75 
76     /* Delete the Threadx queue.  */
77     if(tx_queue_delete(queue))
78     {
79         /* return generic error.  */
80         posix_internal_error(444);
81         /* return error.  */
82         return(ERROR);
83     }
84 
85     /* Release the queue back to the pool.  */
86     posix_reset_queue(q_ptr);
87     q_ptr = NULL;
88     return(OK);
89 }
90