Dumps.idl

Go to the documentation of this file.

/**
 * @file   Dumps.idl
 * @brief  Managing of coredumps
 *
 * @author Frantisek Boranek, Dusan Juhas
 *
 * @copyright Copyright © 2017 Kerio Technologies s.r.o.
 */
#import <kerio/web/idl/SharedStructures.idl>
#import <kerio/assist/idl/Assist.idl>

module kerio {
module web {

struct CoreDump {
   kerio::web::ByteValueWithUnits size;
   DateTimeStamp timestamp;
};

struct CoreDumpWithImportance {
   kerio::web::ByteValueWithUnits   size;
   DateTimeStamp              timestamp;
   kerio::assist::Importance     importance;
};

typedef sequence<CoreDump> DumpList;
typedef sequence<CoreDumpWithImportance> DumpListWithImportance;


interface Dumps {

   /**
    * Obtain list of available crash dumps
    *
    * @param dumps - list of all available crash dumps
    */
   void get(out DumpList dumps);
   /**
    * Obtain list of available crash dumps with highest importance
    *
    * @param dumps - list of all available crash dumps with importance
    */
   void getWithImportance(out DumpListWithImportance dumps);

   /**
    * Remove all crash dumps from server disk
    */
   void remove();

   /**
    * Upload last available crash dump to Kerio.
    *
    * @param description - plain text information to be sent with crash dump
    * @param email - contact information to be sent with crash dump
    */
   void send(in string description, in string email);
};

}; // module web
}; // module kerio