Application messages. More...

Classes
struct	gf::Message
	The base class for all messages. More...

class	gf::MessageManager
	A message manager. More...

Typedefs
using	gf::MessageHandler = std::function< MessageStatus(Id, Message *)>
	A message handler. More...

using	gf::MessageHandlerId = uint64_t
	An identifier for a message handler. More...

Enumerations
enum class	gf::MessageStatus { gf::MessageStatus::Keep , gf::MessageStatus::Die }
	A message status. More...

Detailed Description

Application messages.

Typedef Documentation

◆ MessageHandler

using gf::MessageHandler = typedef std::function<MessageStatus(Id, Message *)>

A message handler.

gf::MessageHandler is a function that can be called when a message is sent in a message handler. It can be a free function:

gf::MessageStatus onHeroPosition(gf::Id type, gf::Message *msg) {
  assert(type == HeroPosition::type);
  auto heroPosition = static_cast<HeroPosition*>(msg);
 
  // do something with heroPosition->position ...
 
  return gf::MessageStatus::Keep;
}
 
// ...
 
gf::MessageHandler handler = onHeroPosition;

It can also be a member function (which is, in fact, the most probable use case).

struct Foo {
  gf::MessageStatus onHeroPosition(gf::Id type, gf::Message *msg) {
    assert(type == HeroPosition::type);
    auto heroPosition = static_cast<HeroPosition*>(msg);
 
    // do something with heroPosition->position ...
 
    return gf::MessageStatus::Keep;
  }
};
 
// ...
 
Foo foo;
gf::MessageHandler handler = std::bind(&Foo::onHeroPosition, &foo);