Difference between revisions of "Truxton etl set description"
Jump to navigation
Jump to search
(Created page with "This is used to build the command line arguments for the process. Truxton will automatically parse the command line for you but this allows you to programmatically force comma...") |
(→Sample) |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | This is | + | This is a longer form description of what your ETL does. |
| − | |||
=Syntax= | =Syntax= | ||
| − | < | + | <source lang="C"> |
| − | void truxton_etl_set_description(uint64_t etl_handle, char const * description) | + | void truxton_etl_set_description( uint64_t etl_handle, char const * description ); |
| − | </ | + | </source> |
=Parameters= | =Parameters= | ||
| Line 16: | Line 15: | ||
=Sample= | =Sample= | ||
| − | + | <source lang="C" highlight="15"> | |
| − | < | ||
#include <TruxtonCAPI.h> | #include <TruxtonCAPI.h> | ||
| Line 24: | Line 22: | ||
char file_id[ 65 ]; | char file_id[ 65 ]; | ||
char description[ 128 ]; | char description[ 128 ]; | ||
| − | |||
| − | |||
uint64_t message = 0; | uint64_t message = 0; | ||
| Line 34: | Line 30: | ||
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) ); | |
| + | |||
| + | // Pause here until we get a message from the "SampleC" message queue | ||
| + | message = truxton_etl_get_message( app ); | ||
| − | while( | + | 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 11:26, 10 February 2021
This is a longer form description of what your ETL does.
Syntax
void truxton_etl_set_description( uint64_t etl_handle, char const * description );
Parameters
etl_handle
The handle created by the truxton_etl_create call.
description
A human readable string that describes what your ETL process is supposed to do.
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 );
}
