Difference between revisions of "Truxton etl get description"
Jump to navigation
Jump to search
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | This | + | This retrieves the description of the ETL application. |
| − | |||
=Syntax= | =Syntax= | ||
| − | < | + | <source lang="C"> |
| − | void truxton_etl_get_description(uint64_t etl_handle, char * destination_string, size_t maximum_size); | + | void truxton_etl_get_description( uint64_t etl_handle, char * destination_string, size_t maximum_size ); |
| − | </ | + | </source> |
=Parameters= | =Parameters= | ||
==<code>etl_handle</code>== | ==<code>etl_handle</code>== | ||
| − | |||
The handle created by the [[truxton_etl_create]] call. | The handle created by the [[truxton_etl_create]] call. | ||
| Line 18: | Line 16: | ||
The size of the <code>destination_string</code> buffer. | The size of the <code>destination_string</code> buffer. | ||
The maximum number of characters written to the buffer will be <code>maximum_size</code> minus one to leave room for the [https://en.wikipedia.org/wiki/Null-terminated_string null terminator.] | The maximum number of characters written to the buffer will be <code>maximum_size</code> minus one to leave room for the [https://en.wikipedia.org/wiki/Null-terminated_string null terminator.] | ||
| + | |||
| + | =Remarks= | ||
| + | This name was set using the <code>[[truxton_etl_set_description]]()</code> function. | ||
=Sample= | =Sample= | ||
| − | < | + | <source lang="C" highlight="16"> |
#include <TruxtonCAPI.h> | #include <TruxtonCAPI.h> | ||
| Line 27: | Line 28: | ||
char file_id[ 65 ]; | char file_id[ 65 ]; | ||
char description[ 128 ]; | char description[ 128 ]; | ||
| − | |||
| − | |||
uint64_t message = 0; | uint64_t message = 0; | ||
| Line 37: | Line 36: | ||
truxton_etl_set_queue_name( app, "SampleC" ); | truxton_etl_set_queue_name( app, "SampleC" ); | ||
| − | truxton_etl_set_description( app, "A sample of how to write an ETL"); | + | truxton_etl_set_description( app, "A sample of how to write an ETL" ); |
| − | truxton_etl_get_description( app, description, sizeof(description)); | + | truxton_etl_get_description( app, description, sizeof(description) ); |
| − | while( | + | // Pause here until we get a message from the "SampleC" message queue |
| + | message = truxton_etl_get_message( app ); | ||
| + | |||
| + | while( message != 0 ) | ||
{ | { | ||
| − | message | + | // Do something with the message |
| − | + | memset( file_id, 0x00, sizeof( file_id ) ); | |
| − | + | truxton_message_get_file_id( message, file_id, sizeof( file_id ) ); | |
| − | |||
| − | + | printf( "Received file id %s\n", file_id ); | |
| − | |||
| − | + | truxton_message_destroy( message ); | |
| − | + | // Pause here until we get another message from the "SampleC" message queue | |
| − | + | message = truxton_etl_get_message( app ); | |
| − | |||
| − | |||
| − | |||
| − | |||
} | } | ||
| + | |||
| + | truxton_etl_destroy( app ); | ||
} | } | ||
| − | </ | + | </source> |
Latest revision as of 15:17, 19 March 2021
This retrieves the description of the ETL application.
Contents
Syntax
void truxton_etl_get_description( uint64_t etl_handle, char * destination_string, size_t maximum_size );
Parameters
etl_handle
The handle created by the truxton_etl_create call.
destination_string
The string buffer where the description will go.
maximum_size
The size of the destination_string buffer.
The maximum number of characters written to the buffer will be maximum_size minus one to leave room for the null terminator.
Remarks
This name was set using the truxton_etl_set_description() function.
Sample
#include <TruxtonCAPI.h>
void main( void )
{
char file_id[ 65 ];
char description[ 128 ];
uint64_t message = 0;
uint64_t app = truxton_etl_create();
truxton_etl_set_application_name( app, "Sample C ETL" );
truxton_etl_set_stage_number( app, 42 );
truxton_etl_set_queue_name( app, "SampleC" );
truxton_etl_set_description( app, "A sample of how to write an ETL" );
truxton_etl_get_description( app, description, sizeof(description) );
// Pause here until we get a message from the "SampleC" message queue
message = truxton_etl_get_message( app );
while( message != 0 )
{
// Do something with the message
memset( file_id, 0x00, sizeof( file_id ) );
truxton_message_get_file_id( message, file_id, sizeof( file_id ) );
printf( "Received file id %s\n", file_id );
truxton_message_destroy( message );
// Pause here until we get another message from the "SampleC" message queue
message = truxton_etl_get_message( app );
}
truxton_etl_destroy( app );
}
