mq.h File Reference

GRTOS Message queue definitions. More...

Go to the source code of this file.

Data Structures
struct	T_QUEUE_RESOURCE
	Message Queue Resource. More...
struct	queue_buffer
	BUFFER CONTROL BLOCK FOR UNION WITH RRDS STRUCT. More...

Detailed Description

GRTOS Message queue definitions.

Author

Ricardo Cayssials

This file contains the Message queue definitions.

Version

0.9a

Date

2015-2020

Bug:

None known

Copyright

Ricardo Cayssials (rcays.nosp@m.sial.nosp@m.s@gma.nosp@m.il.c.nosp@m.om)

All rights reserved.

Copyright (c) 2013-2020

Warning

This product was produced by Ricardo Cayssials in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

DISCLAIMER OF WARRANTY. THIS PRODUCT IS LICENSED "AS IS." YOU BEAR THE RISK OF USING IT.

RICARDO CAYSSIALS GIVES NO EXPRESS WARRANTIES, GUARANTEES, OR CONDITIONS. TO THE EXTENT PERMITTED UNDER APPLICABLE LAWS, RICARDO CAYSSIALS EXCLUDES ALL IMPLIED WARRANTIES, INCLUDING MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.

Definition in file mq.h.

Function Documentation

gk_check_consume()

INT32 gk_check_consume ( GS_ECB *  pbuffer )

related

gk_MQ_move_to_consumer()

INT32 gk_MQ_move_to_consumer	(	GS_RRDS *	pbuffer_consumer,
		INT32	start_byte_id,
		INT32	bytes_count
	)

gk_MQ_Read_Sender()

INT32 gk_MQ_Read_Sender

(

void

)

gk_MQ_send()

INT32 gk_MQ_send ( G_RCB *  prcb, void *  pmsg, INT32  msg_length, gt_time  timeout  )

related

gk_QUEUE_granted_kill()

INT32 gk_QUEUE_granted_kill

(

GS_ECB *

pevent

)

Definition at line 396 of file mq.c.

gk_timeout_ECB_MQ_consume()

INT32 gk_timeout_ECB_MQ_consume ( GS_ECB *  peventime )

related

gk_timeout_ECB_MQ_send()

INT32 gk_timeout_ECB_MQ_send ( GS_ECB *  peventime )

related

gu_MQ_consumer_mark_read()

INT32 gu_MQ_consumer_mark_read

(

GS_ECB *

pevent

)

Mark the current buffer as read.

gu_MQ_consumer_mark_read

Parameters

[in]

pevent

Pointer to the ECB associated as consumer to the Message Queue

Returns

G_TRUE when successful, G_FALSE otherwise

This function has to be executed to enable the reading of the next message

Definition at line 331 of file mq.c.

gu_MQ_receive()

INT32 gu_MQ_receive

(

GS_ECB *

pevent

)

gu_queue_consume()

GS_ECB* gu_queue_consume ( G_RCB *  presource, void *  pbuffer, INT32  buffer_length, gt_time  timeout  )

related

gu_queue_create()

G_RCB* gu_queue_create	(	void *	pbuffer,
		INT32	buffer_length
	)

Create a Resource for Queue with default settings.

Parameters

[in]	pbuffer	Pointer to the buffer where data sent to the queue will be transfered.
[in]	buffer_length	Length of the buffer of the queue

Returns

Return a pointer to the resource of the Queue, or 0 if there is not more resources availables

A memory buffer should be summited in order to store the data sent to the queue.

Definition at line 185 of file mq.c.