---

konspire2b_cpp_only.h

Go to the documentation of this file.

/*
 * Modification History
 *
 * 2002-July-31   Jason Rohrer
 * Created.
 *
 * 2002-October-29    Jason Rohrer
 * Changed comments to work better with doxygen.
 */



/**
 * @file konspire2b_cpp_only.h
 *
 * This file contains a more advanced broadcast initiation function
 * that requires C++.
 *
 * @author Jason Rohrer
 */



#ifndef KONSPIRE_2B_API_CPP_ONLY_INCLUDED
#define KONSPIRE_2B_API_CPP_ONLY_INCLUDED



#include "ContentSource.h"



/**
 * Sends a broadcast, specifying a content source instead of a file.
 * This version of initiateBroadcast allows for content that is not
 * in a file (for example, content that is generated on the fly). 
 *
 * Note:
 * If a sender key exists for the specified channel, it will be used
 * to sign the broadcast.
 *
 * @param inChannelName the channel to send the broadcast on.
 * @param inBroadcastName the name of the broadcast (for example,
 *   the file name, if appropriate).
 * @param inBroadcastComment the comment for the broadcast.
 * @param inContentSource the source for the content.
 *   Will be destroyed by the callee.
 * @param inContentType the MIME type of the content, or NULL if the
 *   content has no type.
 *
 * Example: <PRE>
 * k2bInitiateBroadcast( "testChan",
 *                       "testBroadcast.txt",
 *                       "This is a test broadcast.",
 *                       new FileContentSource(
 *                           new File( NULL, "myFile.txt" ) ),
 *                       "text/plain" );
 * </PRE>
 */
void k2bInitiateBroadcast( char *inChannelName,
                           char *inBroadcastName,
                           char *inBroadcastComment,
                           ContentSource *inContentSource,
                           char *inContentType );



#endif

---