dlt_filetransfer.h

Go to the documentation of this file.

/*
 * @licence app begin@
 * SPDX license identifier: MPL-2.0
 *
 * Copyright (C) 2011-2015, BMW AG
 *
 * This file is part of GENIVI Project DLT - Diagnostic Log and Trace.
 *
 * This Source Code Form is subject to the terms of the
 * Mozilla Public License (MPL), v. 2.0.
 * If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * For further information see http://www.genivi.org/.
 * @licence end@
 */

#include <limits.h>    /* Needed for LONG_MAX */
#include <sys/stat.h>  /* Needed for struct stat st*/
#include "dlt.h"       /* Needed for DLT Logs */
#include <signal.h>    /* Signal handling */
#include "errno.h"


/* ! Error code for dlt_user_log_file_complete */
#define DLT_FILETRANSFER_ERROR_FILE_COMPLETE -300
/* ! Error code for dlt_user_log_file_complete */
#define DLT_FILETRANSFER_ERROR_FILE_COMPLETE1 -301
/* ! Error code for dlt_user_log_file_complete */
#define DLT_FILETRANSFER_ERROR_FILE_COMPLETE2 -302
/* ! Error code for dlt_user_log_file_complete */
#define DLT_FILETRANSFER_ERROR_FILE_COMPLETE3 -303
/* ! Error code for dlt_user_log_file_head */
#define DLT_FILETRANSFER_ERROR_FILE_HEAD -400
/* ! Error code for dlt_user_log_file_data */
#define DLT_FILETRANSFER_ERROR_FILE_DATA -500
/* ! Error code for dlt_user_log_file_data */
#define DLT_FILETRANSFER_ERROR_FILE_DATA_USER_BUFFER_FAILED -501
/* ! Error code for dlt_user_log_file_end */
#define DLT_FILETRANSFER_ERROR_FILE_END -600
/* ! Error code for dlt_user_log_file_infoAbout */
#define DLT_FILETRANSFER_ERROR_INFO_ABOUT -700
/* ! Error code for dlt_user_log_file_packagesCount */
#define DLT_FILETRANSFER_ERROR_PACKAGE_COUNT -800


/* !Transfer the complete file as several dlt logs. */
extern int dlt_user_log_file_complete(DltContext *fileContext, const char *filename, int deleteFlag, int timeout);


/* !This method gives information about the number of packages the file have */
extern int dlt_user_log_file_packagesCount(DltContext *fileContext, const char *filename);


/* !Logs specific file inforamtions to dlt */
extern int dlt_user_log_file_infoAbout(DltContext *fileContext, const char *filename);


/* !Transfer the head of the file as a dlt logs. */
extern int dlt_user_log_file_header_alias(DltContext *fileContext, const char *filename, const char *alias);

/* !Transfer the head of the file as a dlt logs. */
extern int dlt_user_log_file_header(DltContext *fileContext, const char *filename);


/* !Transfer the content data of a file. */
extern int dlt_user_log_file_data(DltContext *fileContext, const char *filename, int packageToTransfer, int timeout);



/* !Transfer the end of the file as a dlt logs. */
extern int dlt_user_log_file_end(DltContext *fileContext, const char *filename,int deleteFlag);