Difference between revisions of "Truxton etl set application name"

From truxwiki.com
Jump to navigation Jump to search
Line 3: Line 3:
 
=Syntax=
 
=Syntax=
 
<syntaxhighlight lang="C">
 
<syntaxhighlight lang="C">
void truxton_etl_set_application_name( uint64_t etl_handle, char const * name )
+
void truxton_etl_set_application_name( uint64_t etl_handle, char const * name );
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 19: Line 19:
  
 
=Sample=
 
=Sample=
 
 
<syntaxhighlight lang="C" highlight="13">
 
<syntaxhighlight lang="C" highlight="13">
 
#include <TruxtonCAPI.h>
 
#include <TruxtonCAPI.h>

Revision as of 06:48, 10 June 2020

This gives your ETL a human friendly name.

Syntax

void truxton_etl_set_application_name( uint64_t etl_handle, char const * name );

Parameters

etl_handle

The handle created by the truxton_etl_create call.

name

A short human readable string that identifies your exploitation process.

Remarks

If you do not set the queue name, then the application name becomes the queue name by having all letters converted to lower case and spaces removed. An application name of "Sample ETL" would cause the message queue name to be "sampleetl" unless otherwise specified.

Sample

#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_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;
        }
    }
}