OCEOS/oceos inter-task communication/dataq - Revision history

Okhoruzhyy: /* oceos_dataq_clear() */

2022-03-22T17:52:58Z

oceos_dataq_clear()

← Older revision		Revision as of 17:52, 22 March 2022
Line 425:		Line 425:

	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
			Clears data queue and frees tasks on pending queue.

	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			enum DIRECTIVE_STATUS oceos_dataq_clear(
			dataq_t dataq_id // data queue ID
			);
	</syntaxhighlight>		</syntaxhighlight>
	<span style="color:#1b7ac2">'''Parameters'''</span><br>		<span style="color:#1b7ac2">'''Parameters'''</span><br>
Line 435:		Line 438:
	! Parameter !! Description		! Parameter !! Description
	\|-		\|-
	\| \|\|		\| dataq_id \|\| Data queue ID
	\|}		\|}
	<span style="color:#1b7ac2">'''Returns'''</span><br>		<span style="color:#1b7ac2">'''Returns'''</span><br>
Line 443:		Line 446:
	! enum DIRECTIVE_STATUS !! Description		! enum DIRECTIVE_STATUS !! Description
	\|-		\|-
	\| ~~INCORRECT_STATE~~ \|\| ~~If system Meta~~ pointer is NULL or		\|NOT_CONFIGURED \|\| System meta pointer is NULL
	~~Init pointer is NULL or~~
	~~Start up phase check fail or~~
	~~Fixed data checksum failed (check log)~~
	\|-		\|-
	\| ~~INVALID_NAME~~ \|\| ~~If Start Sentinel for fixed area~~ is ~~corrupt or~~		\|INCORRECT_STATE \|\| Init meta pointer is NULL
	~~Start Sentinel for dynamic area is corrupt~~
	\|-		\|-
	\| ~~INVALID_NUMBER~~ \|\| ~~If Configuration and actual parameters do not match~~		\|INVALID_ID \|\| Data queue ID is out of range
	~~(In configuration file was defined 5 tasks, but created less)~~
	\|-		\|-
	\| SUCCESSFUL \|\| If All OK		\|INTERNAL_ERROR \|\| Wrong task index on pending queue or
			Failed to remove task from timed action queue if timeout is used
			\|-
			\|SUCCESSFUL \|\| All is OK
	\|}		\|}
	<span style="color:#1b7ac2">'''Example Usage'''</span><br>		<span style="color:#1b7ac2">'''Example Usage'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			enum DATAQ_NAME{
	</syntaxhighlight>		d_apple,
			d_orange,
			};
			enum DIRECTIVE_STATUS status;
			status = oceos_dataq_clear(d_apple);
			if(SUCCESSFUL != status ){
			// Handle ERROR
			}
			</syntaxhighlight>
	</blockquote>		</blockquote>

	[[Category:backup]]		[[Category:backup]]

Okhoruzhyy: /* oceos_dataq_penq_get_size() */

2022-03-22T17:48:50Z

oceos_dataq_penq_get_size()

← Older revision		Revision as of 17:48, 22 March 2022
Line 380:		Line 380:

	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
			Returns number of jobs on the data queue pending job's queue.

	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			int oceos_dataq_penq_get_size(
			dataq_t dataq_id // data queue ID
			);
	</syntaxhighlight>		</syntaxhighlight>
	<span style="color:#1b7ac2">'''Parameters'''</span><br>		<span style="color:#1b7ac2">'''Parameters'''</span><br>
Line 390:		Line 393:
	! Parameter !! Description		! Parameter !! Description
	\|-		\|-
	\| \|\|		\| dataq_id \|\| Data queue ID
	\|}		\|}
	<span style="color:#1b7ac2">'''Returns'''</span><br>		<span style="color:#1b7ac2">'''Returns'''</span><br>
	This function returns ~~enum DIRECTIVE_STATUS~~.<br>		This function returns int.<br>
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
	! ~~enum DIRECTIVE_STATUS~~ !! Description		! int !! Description
	\|-
	~~\| INCORRECT_STATE \|\| If system Meta pointer is NULL or~~
	~~Init pointer is NULL or~~
	~~Start up phase check fail or~~
	~~Fixed data checksum failed (check log)~~
	\|-
	~~\| INVALID_NAME \|\| If Start Sentinel for fixed area is corrupt or~~
	~~Start Sentinel for dynamic area is corrupt~~
	\|-		\|-
	\| ~~INVALID_NUMBER~~ \|\| ~~If Configuration and actual parameters do not match~~		\| -1 \|\| ERROR
	~~(In configuration file was defined 5 tasks, but created less)~~
	\|-		\|-
	\| ~~SUCCESSFUL~~ \|\| ~~If All OK~~		\| >= 0 \|\| Number of Items on data queue with ID
	\|}		\|}
	<span style="color:#1b7ac2">'''Example Usage'''</span><br>		<span style="color:#1b7ac2">'''Example Usage'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			enum DATAQ_NAME{
	</syntaxhighlight>		d_apple,
			d_orange,
			};
			int count;
			count = oceos_dataq_penq_get_size(d_apple);
			if(-1 == count){
			// Handle ERROR
			}
			</syntaxhighlight>
	</blockquote>		</blockquote>

Okhoruzhyy: /* oceos_dataq_get_size() */

2022-03-22T17:46:04Z

oceos_dataq_get_size()

← Older revision		Revision as of 17:46, 22 March 2022
Line 335:		Line 335:

	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
			Returns number of items on the data queue with ID.

	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			int oceos_dataq_get_size(
			dataq_t dataq_id // data queue ID
			);
	</syntaxhighlight>		</syntaxhighlight>
	<span style="color:#1b7ac2">'''Parameters'''</span><br>		<span style="color:#1b7ac2">'''Parameters'''</span><br>
Line 345:		Line 348:
	! Parameter !! Description		! Parameter !! Description
	\|-		\|-
	\| \|\|		\| dataq_id \|\| data queue ID
	\|}		\|}
	<span style="color:#1b7ac2">'''Returns'''</span><br>		<span style="color:#1b7ac2">'''Returns'''</span><br>
	This function returns ~~enum DIRECTIVE_STATUS~~.<br>		This function returns int.<br>
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
	! ~~enum DIRECTIVE_STATUS~~ !! Description		! int !! Description
	\|-
	~~\| INCORRECT_STATE \|\| If system Meta pointer is NULL or~~
	~~Init pointer is NULL or~~
	~~Start up phase check fail or~~
	~~Fixed data checksum failed (check log)~~
	\|-
	~~\| INVALID_NAME \|\| If Start Sentinel for fixed area is corrupt or~~
	~~Start Sentinel for dynamic area is corrupt~~
	\|-		\|-
	\| ~~INVALID_NUMBER~~ \|\| ~~If Configuration and actual parameters do not match~~		\| -1 \|\| ERROR
	~~(In configuration file was defined 5 tasks, but created less)~~
	\|-		\|-
	\| ~~SUCCESSFUL~~ \|\| ~~If All OK~~		\| >= 0 \|\| Number of Items on data queue with ID
	\|}		\|}
	<span style="color:#1b7ac2">'''Example Usage'''</span><br>		<span style="color:#1b7ac2">'''Example Usage'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			enum DATAQ_NAME{
	</syntaxhighlight>		d_apple,
			d_orange,
			};
			int count;
			count = oceos_dataq_get_size(d_apple);
			if(-1 == count){
			// Handle ERROR
			}
			</syntaxhighlight>
	</blockquote>		</blockquote>

Okhoruzhyy: /* oceos_dataq_read_restart_timeout() */

2022-03-22T17:42:47Z

oceos_dataq_read_restart_timeout()

← Older revision		Revision as of 17:42, 22 March 2022
Line 281:		Line 281:

	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
			Read data queue next item. This directive returns the oldest pointer from the data queue. If the queue is empty the task is put on the pending queue to be restarted when new data is available on the queue by [[OCEOS/oceos inter-task communication/dataq#oceos_dataq_write()\|oceos_dataq_write()]] or by timeout if timeout parameter is != 0. A 64-bit timeout in microseconds can be set, after which the task will be removed from the pending queue and NULL will be returned. If a timeout value of zero is passed then the job will remain on the pending queue until a data queue pointer is available.
			<blockquote style="background-color: #c6e2f7; border-left-style: solid; border-left-width: 3px; border-left-color: blue; "> '''Note'''<br>
			In order to use timeouts, timed actions must be configured, please see [[OCEOS/oceos timed actions\|here]] and data queue is created with timeout parameter set to TRUE.
			</blockquote>
			Restarted task will lose any data stored in variables on the stack so it may be necessary for the application to store such data elsewhere so that it is available when the task restarts.

	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			void* oceos_dataq_read_restart_timeout(
			dataq_t dataq_id, // data queue ID
			U64_t timeout // timeout, restart time if no entry, 0 => ignore
			);
	</syntaxhighlight>		</syntaxhighlight>
	<span style="color:#1b7ac2">'''Parameters'''</span><br>		<span style="color:#1b7ac2">'''Parameters'''</span><br>
Line 291:		Line 299:
	! Parameter !! Description		! Parameter !! Description
	\|-		\|-
	\| \|\|		\|dataq_id \|\| Data queue ID
			\|-
			\|timeout \|\| Timeout, restart time if no entry, 0 => ignore
	\|}		\|}
	<span style="color:#1b7ac2">'''Returns'''</span><br>		<span style="color:#1b7ac2">'''Returns'''</span><br>
	This function returns ~~enum DIRECTIVE_STATUS~~.<br>		This function returns void*.<br>
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
	! ~~enum DIRECTIVE_STATUS~~ !! Description		! void* !! Description
	\|-		\|-
	\| ~~INCORRECT_STATE~~ \|\| ~~If system Meta pointer is NULL~~ or		\| NULL \|\| System check ERROR or
	~~Init pointer is NULL or~~		Task was originally started from data queue pending queue
	~~Start up phase check fail~~ or		or timeout data queue pending queue is full (check system log)
	~~Fixed~~ data ~~checksum failed~~ (check log)
	\|-		\|-
	\| ~~INVALID_NAME \|\| If Start Sentinel for fixed area is corrupt or~~		\| Data \|\| Pointer to the data
	~~Start Sentinel for dynamic area is corrupt~~
	\|-
	~~\| INVALID_NUMBER \|\| If Configuration and actual parameters do not match~~
	~~(In configuration file was defined 5 tasks, but created less)~~
	\|-
	~~\| SUCCESSFUL~~ \|\| ~~If All OK~~
	\|}		\|}
	<span style="color:#1b7ac2">'''Example Usage'''</span><br>		<span style="color:#1b7ac2">'''Example Usage'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			enum DATAQ_NAME{
	</syntaxhighlight>		d_apple,
			d_orange,
			};
			void* data;
			data = oceos_dataq_read_restart_timeout(d_apple, 10000);
			if(NULL == data){
			// Handle ERROR
			}
			</syntaxhighlight>
	</blockquote>		</blockquote>

Okhoruzhyy: /* oceos_dataq_read_restart() */

2022-03-22T17:19:53Z

oceos_dataq_read_restart()

← Older revision		Revision as of 17:19, 22 March 2022
Line 234:		Line 234:

	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
			Read data queue next item. If data queue is empty, task is put on pending queue for this data queue and restarted by [[OCEOS/oceos inter-task communication/dataq#oceos_dataq_write()\|oceos_dataq_write()]]. Restarted task will lose any data stored in variables on the stack so it may be necessary for the application to store such data elsewhere so that it is available when the task restarts.

	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			void* oceos_dataq_read_restart(
			dataq_t dataq_id // data queue ID
			);
	</syntaxhighlight>		</syntaxhighlight>
	<span style="color:#1b7ac2">'''Parameters'''</span><br>		<span style="color:#1b7ac2">'''Parameters'''</span><br>
Line 244:		Line 247:
	! Parameter !! Description		! Parameter !! Description
	\|-		\|-
	\| \|\|		\| dataq_id \|\| Data queue ID
	\|}		\|}
	<span style="color:#1b7ac2">'''Returns'''</span><br>		<span style="color:#1b7ac2">'''Returns'''</span><br>
	This function returns ~~enum DIRECTIVE_STATUS~~.<br>		This function returns void*.<br>
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
	! ~~enum DIRECTIVE_STATUS~~ !! Description		! void* !! Description
	\|-
	~~\| INCORRECT_STATE \|\| If system Meta pointer is NULL or~~
	~~Init pointer is NULL or~~
	~~Start up phase check fail or~~
	~~Fixed data checksum failed (check log)~~
	\|-
	~~\| INVALID_NAME \|\| If Start Sentinel for fixed area is corrupt or~~
	~~Start Sentinel for dynamic area is corrupt~~
	\|-		\|-
	\| ~~INVALID_NUMBER~~ \|\| ~~If Configuration and actual parameters do not match~~		\| NULL \|\| System check ERROR or
	(~~In configuration file was defined 5 tasks, but created less~~)		Task was originally started from data queue pending queue or
			data queue pending queue is full (check system log)
	\|-		\|-
	\| ~~SUCCESSFUL~~ \|\| ~~If All OK~~		\| data \|\| Pointer to the data
	\|}		\|}
	<span style="color:#1b7ac2">'''Example Usage'''</span><br>		<span style="color:#1b7ac2">'''Example Usage'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			enum DATAQ_NAME{
	</syntaxhighlight>		d_apple,
			d_orange,
			};
			void* data;
			data = oceos_dataq_read_restart(d_apple);
			if(NULL == data){
			// Handle ERROR
			}
			</syntaxhighlight>
	</blockquote>		</blockquote>

Okhoruzhyy: /* oceos_dataq_read_continue() */

2022-03-22T17:12:49Z

oceos_dataq_read_continue()

← Older revision		Revision as of 17:12, 22 March 2022
Line 220:		Line 220:
	d_orange,		d_orange,
	};		};
	void* ~~status~~;		void* data;
	~~status~~ = oceos_dataq_read_continue(d_apple);		data = oceos_dataq_read_continue(d_apple);
	if(NULL == ~~status~~){		if(NULL == data){
	// Handle ERROR		// Handle ERROR
	}		}

Okhoruzhyy: /* oceos_dataq_read_continue() */

2022-03-22T16:53:56Z

oceos_dataq_read_continue()

← Older revision		Revision as of 16:53, 22 March 2022
Line 189:		Line 189:

	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
			Read data queue, if empty it returns NULL.

	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			void* oceos_dataq_read_continue(
			dataq_t dataq_id // data queue ID
			);
	</syntaxhighlight>		</syntaxhighlight>
	<span style="color:#1b7ac2">'''Parameters'''</span><br>		<span style="color:#1b7ac2">'''Parameters'''</span><br>
Line 199:		Line 202:
	! Parameter !! Description		! Parameter !! Description
	\|-		\|-
	\| \|\|		\| dataq_id \|\| Data queue ID
	\|}		\|}
	<span style="color:#1b7ac2">'''Returns'''</span><br>		<span style="color:#1b7ac2">'''Returns'''</span><br>
	This function returns ~~enum DIRECTIVE_STATUS~~.<br>		This function returns void*.<br>
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
	! ~~enum DIRECTIVE_STATUS~~ !! Description		! void* !! Description
	\|-
	~~\| INCORRECT_STATE \|\| If system Meta pointer is NULL or~~
	~~Init pointer is NULL or~~
	~~Start up phase check fail or~~
	~~Fixed data checksum failed (check log)~~
	\|-
	~~\| INVALID_NAME \|\| If Start Sentinel for fixed area is corrupt or~~
	~~Start Sentinel for dynamic area is corrupt~~
	\|-		\|-
	\| ~~INVALID_NUMBER~~ \|\| ~~If Configuration and actual parameters do not match~~		\| NULL \|\| System check ERROR (check system log)
	(~~In configuration file was defined 5 tasks, but created less~~)
	\|-		\|-
	\| ~~SUCCESSFUL~~ \|\| ~~If All OK~~		\| data \|\| Pointer to the data
	\|}		\|}
	<span style="color:#1b7ac2">'''Example Usage'''</span><br>		<span style="color:#1b7ac2">'''Example Usage'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			enum DATAQ_NAME{
			d_apple,
			d_orange,
			};
			void* status;
			status = oceos_dataq_read_continue(d_apple);
			if(NULL == status){
			// Handle ERROR
			}
	</syntaxhighlight>		</syntaxhighlight>
	</blockquote>		</blockquote>

Okhoruzhyy: /* oceos_dataq_write() */

2022-03-22T16:47:20Z

oceos_dataq_write()

← Older revision		Revision as of 16:47, 22 March 2022
Line 170:		Line 170:
	<span style="color:#1b7ac2">'''Example Usage'''</span><br>		<span style="color:#1b7ac2">'''Example Usage'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
	enum DATAQ_NAME{		enum DATAQ_NAME{
	d_apple,		d_apple,
	d_orange,		d_orange,
	};		};
	char *mes = "OCEOS";		char *mes = "OCEOS";
	enum DIRECTIVE_STATUS status;		enum DIRECTIVE_STATUS status;
	status = oceos_dataq_write(~~d_olja~~, mes);		status = oceos_dataq_write(d_apple, mes);
	if(SUCCESSFUL != status){		if(SUCCESSFUL != status){
	// Handle ERROR		// Handle ERROR
	}		}
	</syntaxhighlight>		</syntaxhighlight>
	</blockquote>		</blockquote>

Okhoruzhyy: /* oceos_dataq_write() */

2022-03-22T16:46:40Z

oceos_dataq_write()

← Older revision		Revision as of 16:46, 22 March 2022
Line 128:		Line 128:

	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
			Puts pointer to the data on data queue. Pointer to the data must not be NULL.

	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			enum DIRECTIVE_STATUS oceos_dataq_write(
			dataq_t dataq_id, // data queue ID
			void* data // non-null pointer to data
			);
	</syntaxhighlight>		</syntaxhighlight>
	<span style="color:#1b7ac2">'''Parameters'''</span><br>		<span style="color:#1b7ac2">'''Parameters'''</span><br>
Line 138:		Line 142:
	! Parameter !! Description		! Parameter !! Description
	\|-		\|-
	\| \|\|		\| dataq_id \|\| Data queue ID
			\|-
			\| data \|\| Non-null pointer to data
	\|}		\|}
	<span style="color:#1b7ac2">'''Returns'''</span><br>		<span style="color:#1b7ac2">'''Returns'''</span><br>
Line 146:		Line 152:
	! enum DIRECTIVE_STATUS !! Description		! enum DIRECTIVE_STATUS !! Description
	\|-		\|-
	\| ~~INCORRECT_STATE~~ \|\| ~~If system Meta~~ pointer is NULL or		\|NOT_CONFIGURED \|\| System meta pointer is NULL
	Init pointer is NULL or		\|-
	~~Start up phase check fail or~~		\|INCORRECT_STATE \|\| Init meta pointer is NULL
	~~Fixed data checksum failed (check log)~~		\|-
			\|INVALID_ID \|\| Dataq ID is out of range
			\|-
			\|INVALID_ADDRESS \|\| Data pointer is NULL
	\|-		\|-
	\| ~~INVALID_NAME~~ \|\| ~~If Start Sentinel for fixed area~~ is ~~corrupt~~ or		\|TOO_MANY \|\| Dataq is full or
	~~Start Sentinel for dynamic area~~ is ~~corrupt~~		Ready Q is full (check system log)
	\|-		\|-
	\| ~~INVALID_NUMBER~~ \|\| ~~If Configuration and actual parameters do not match~~		\|INTERNAL_ERROR \|\| Wrong task index on pending Q or
	~~(In configuration file was defined 5 tasks, but created less)~~		Failed to remove task from timed action Q if timeout is used
	\|-		\|-
	\| SUCCESSFUL \|\| If All OK		\|SUCCESSFUL \|\| All is OK
	\|}		\|}
	<span style="color:#1b7ac2">'''Example Usage'''</span><br>		<span style="color:#1b7ac2">'''Example Usage'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			enum DATAQ_NAME{
			d_apple,
			d_orange,
			};
			char *mes = "OCEOS";
			enum DIRECTIVE_STATUS status;
			status = oceos_dataq_write(d_olja, mes);
			if(SUCCESSFUL != status){
			// Handle ERROR
			}
	</syntaxhighlight>		</syntaxhighlight>
	</blockquote>		</blockquote>

Okhoruzhyy: /* oceos_dataq_create() */

2022-03-22T16:41:20Z

oceos_dataq_create()

← Older revision		Revision as of 16:41, 22 March 2022
Line 59:		Line 59:
	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
	Create data queue.<br>		Create data queue.<br>
	If use_timeout = TRUE, timed actions must be initialized, please see [[OCEOS/oceos timed actions\|here]]		This directive creates the specified data queue with specified queue size and pending jobs queue size. Roll-over on the queue can also be enabled/disabled. Roll-over means that if the queue is full new entries will overwrite the oldest ones on the queue. If use_timeout = TRUE, timed actions must be initialized, please see [[OCEOS/oceos timed actions\|here]]

	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>