summaryrefslogtreecommitdiff
path: root/examples/ASX/Event_Server/Event_Server/Supplier_Router.h
blob: 42d067a6454d0fcc56203a6aad9d7b8590d48b4e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
/* -*- C++ -*- */
// $Id$

#if !defined (_SUPPLIER_ROUTER_H)
#define _SUPPLIER_ROUTER_H

#include "ace/INET_Addr.h"
#include "ace/SOCK_Acceptor.h"
#include "ace/Map_Manager.h"
#include "ace/Svc_Handler.h"
#include "Peer_Router.h"

class Supplier_Router : public Peer_Router
  // = TITLE
  //     Provides the interface between one or more Suppliers and the
  //     Event Server ACE_Stream.  
  //     
  // = DESCRIPTION
  //     When used on the "reader" side of a Stream, this Router Task
  //     simply forwards all messages up the stream.  When used on the
  //     "writer" side, this Router Task queues up outgoing messages
  //     to suppliers and sends them in a separate thread.  The reason
  //     for this is that it's really an "error" for a
  //     <Supplier_Router> to send messages to Suppliers, so we don't
  //     expect this to happen very much.  when it does we use a
  //     separate thread to avoid taxing the main thread.
{
public:
  Supplier_Router (Peer_Router_Context *prc);
  // Initialization method.

protected:
  // = ACE_Task hooks.

  // All of these methods are called via base class pointers by the
  // ACE Stream apparatus.  Therefore, we can put them in the
  // protected section.

  virtual int open (void *a = 0);
  // Called by the Stream to initialize the router.

  virtual int close (u_long flags = 0);
  // Called by the Stream to shutdown the router.

  virtual int put (ACE_Message_Block *msg, ACE_Time_Value * = 0);
  // Called by the <SUPPLIER_HANDLER> to pass a message to the Router.
  // The Router queues up this message, which is then processed in the
  // <svc> method in a separate thread.

  virtual int svc (void);
  // Runs in a separate thread to dequeue messages and pass them up
  // the stream.

  virtual int info (char **info_string, size_t length) const;
  // Dynamic linking hook.
};

#endif /* _SUPPLIER_ROUTER_H */