Home | History | Annotate | Download | only in crash_generation 
      1 // Copyright (c) 2010 Google Inc.
      2 // All rights reserved.
      3 //
      4 // Redistribution and use in source and binary forms, with or without
      5 // modification, are permitted provided that the following conditions are
      6 // met:
      7 //
      8 //     * Redistributions of source code must retain the above copyright
      9 // notice, this list of conditions and the following disclaimer.
     10 //     * Redistributions in binary form must reproduce the above
     11 // copyright notice, this list of conditions and the following disclaimer
     12 // in the documentation and/or other materials provided with the
     13 // distribution.
     14 //     * Neither the name of Google Inc. nor the names of its
     15 // contributors may be used to endorse or promote products derived from
     16 // this software without specific prior written permission.
     17 //
     18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29 
     30 #ifndef CLIENT_LINUX_CRASH_GENERATION_CRASH_GENERATION_CLIENT_H_
     31 #define CLIENT_LINUX_CRASH_GENERATION_CRASH_GENERATION_CLIENT_H_
     32 
     33 #include "common/basictypes.h"
     34 
     35 #include <stddef.h>
     36 
     37 namespace google_breakpad {
     38 
     39 // CrashGenerationClient is an interface for implementing out-of-process crash
     40 // dumping.  The default implementation, accessed via the TryCreate() factory,
     41 // works in conjunction with the CrashGenerationServer to generate a minidump
     42 // via a remote process.
     43 class CrashGenerationClient {
     44  public:
     45   CrashGenerationClient() {}
     46   virtual ~CrashGenerationClient() {}
     47 
     48   // Request the crash server to generate a dump.  |blob| is an opaque
     49   // CrashContext pointer from exception_handler.h.
     50   // Returns true if the dump was successful; false otherwise.
     51   virtual bool RequestDump(const void* blob, size_t blob_size) = 0;
     52 
     53   // Returns a new CrashGenerationClient if |server_fd| is valid and
     54   // connects to a CrashGenerationServer.  Otherwise, return NULL.
     55   // The returned CrashGenerationClient* is owned by the caller of
     56   // this function.
     57   static CrashGenerationClient* TryCreate(int server_fd);
     58 
     59  private:
     60   DISALLOW_COPY_AND_ASSIGN(CrashGenerationClient);
     61 };
     62 
     63 }  // namespace google_breakpad
     64 
     65 #endif  // CLIENT_LINUX_CRASH_GENERATION_CRASH_GENERATION_CLIENT_H_
     66