Truxton etl set description - Revision history

Sam: /* Sample */

2021-02-10T15:26:11Z

Sample

Sam at 15:20, 10 February 2021

2021-02-10T15:20:09Z

Sam at 19:07, 4 December 2020

2020-12-04T19:07:56Z

Sam at 10:46, 10 June 2020

2020-06-10T10:46:47Z

Sam at 15:06, 26 May 2020

2020-05-26T15:06:36Z

Sam: /* Sample */

2020-05-26T10:40:41Z

Sample

Sam: 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..."

2020-05-26T09:50:30Z

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..."

New page

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 command line options.

=Syntax=
<syntaxhighlight lang="C">
void truxton_etl_set_description(uint64_t etl_handle, char const * description)
</syntaxhighlight>

=Parameters=
==<code>etl_handle</code>==

The handle created by the [[truxton_etl_create]] call.

==<code>description</code>==
A human readable string that describes what your ETL process is supposed to do.

=Sample=

<syntaxhighlight lang="C" highlight="17">
#include <TruxtonCAPI.h>

void main( void )
{
char file_id[ 65 ];
char description[ 128 ];

int exit_loop = 0;

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_add_get_description( app, description, sizeof(description));

while( exit_loop == 0 )
{
message = truxton_etl_get_message( app );

if ( 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 );
}
else
{
exit_loop = 1;
}
}
}
</syntaxhighlight>

@@ Line 50: / Line 50: @@
          message = truxton_etl_get_message( app );
+     }
+}
 </source>

@@ Line 3: / Line 3: @@
 =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>
@@ Line 30: / Line 30: @@
      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) );
      // Pause here until we get a message from the "SampleC" message queue

← Older revision		Revision as of 15:06, 26 May 2020
Line 1:		Line 1:
−	This is ~~used to build the command line arguments for the process.~~	+	This is a longer form description of what your ETL does.
−	~~Truxton will automatically parse the command line for you but this allows you to programmatically force command line options~~.

	=Syntax=		=Syntax=

@@ Line 2: / Line 2: @@
 =Syntax=
-<syntaxhighlight lang="C">
+<source lang="C">
 void truxton_etl_set_description(uint64_t etl_handle, char const * description);
-</syntaxhighlight>
+</source>
 =Parameters=
@@ Line 15: / Line 15: @@
 =Sample=
-<syntaxhighlight lang="C" highlight="17">
+<source lang="C" highlight="15">
 #include <TruxtonCAPI.h>
@@ Line 22: / Line 22: @@
      char file_id[ 65 ];
      char description[ 128 ];
      uint64_t message = 0;
@@ Line 35: / Line 33: @@
      truxton_etl_get_description( app, description, sizeof(description));
-     while( exit_loop == 0 )
+    // Pause here until we get a message from the "SampleC" message queue
+     {
-         message = truxton_etl_get_message( app );
+         // Do something with the message
-         if ( message != 0 )
+         memset( file_id, 0x00, sizeof( file_id ) );
+         truxton_message_get_file_id( message, file_id, sizeof( file_id ) );
-            memset( file_id, 0x00, sizeof( file_id ) );
+        printf( "Received file id %s\n", file_id );
-            printf( "Received file id %s\n", file_id );
+        truxton_message_destroy( message );
-            truxton_message_destroy( message );
+        // Pause here until we get another message from the "SampleC" message queue
+         message = truxton_etl_get_message( app );
+     }
+}
-</syntaxhighlight>
+</source>