CrystalSpace

Public API Reference

Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

iAwsSink Struct Reference
[AWS]

Interface for sinks. More...

#include <iaws/aws.h>

Inheritance diagram for iAwsSink:

iBase List of all members.

Public Member Functions

virtual unsigned long GetTriggerID (const char *name)=0
 Maps a trigger name to a trigger id.
virtual void HandleTrigger (int trigger_id, iAwsSource *source)=0
 Handles trigger events.
virtual void RegisterTrigger (const char *name, void(*Trigger)(void *, iAwsSource *))=0
 A sink should call this to register trigger events.
virtual unsigned int GetError ()=0
 Returns the last error code set.

Detailed Description

Interface for sinks.

Definition at line 615 of file aws.h.


Member Function Documentation

virtual unsigned int iAwsSink::GetError  )  [pure virtual]
 

Returns the last error code set.

This code is good until the next call to this sink. Return value is one of AWS_ERR_SINK_*.

See also:
Sink error codes

virtual unsigned long iAwsSink::GetTriggerID const char *  name  )  [pure virtual]
 

Maps a trigger name to a trigger id.

virtual void iAwsSink::HandleTrigger int  trigger_id,
iAwsSource source
[pure virtual]
 

Handles trigger events.

virtual void iAwsSink::RegisterTrigger const char *  name,
void(*)(void *, iAwsSource *)  Trigger
[pure virtual]
 

A sink should call this to register trigger events.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.3.9.1