megacosession.idl

一个Megaco实现源代码

                         in ConnHandle        conn,
                         in ConnInfoItem      item);

    // Update information about an active connection
    oneway void updateConnInfo(in RequestRef       ref,
                               in SessionUserRef   replyTo,
			       in ConnHandle       conn,
                               in ConnInfoValue    value);

    // Establish a "virtual" connection
    oneway void connect(in RequestRef       ref,
                        in SessionUserRef   replyTo,
                        in ReceiveHandle    rh,
                        in UserMid          remoteMid, 
                        in erlang::binary   sendHandle, 
                        in erlang::pid      controlPid);
    
    // Tear down a "virtual" connection
    oneway void disconnect(in RequestRef       ref,
                           in SessionUserRef   replyTo,
                           in ConnHandle       conn,
                           in string           discoReason);

    // Sends a list of action requests
    // Corresponds to megaco:cast/3
    // The response is returned by handleTransReply/7
    oneway void sendTransRequest(in RequestRef       ref,
                                 in SessionUserRef   replyTo,
                                 in ConnHandle       conn,
                                 in ActionRequests   actions,
                                 in ConnInfoValues   options);

    // Cancel all outstanding messages for this connection
    oneway void cancel(in RequestRef       ref,
                       in SessionUserRef   replyTo,
                       in ConnHandle       conn,
		       in string           cancelReason);
   
    // bugbug call();
    // bugbug parseDigitMap();
    // bugbug evalDigitMap();
    // bugbug reportDigitEvent();
    // bugbug testDigitMap();

    //////////////////////////////////////////////////
    // Responses from user
    //////////////////////////////////////////////////

    oneway void handleConnectResponse(in RequestRef  ref,
                                      in Status      result);

    oneway void handleSyntaxErrorResponse(in RequestRef                     ref,
                                          in Status                         result,
                                          in boolean                        sendReply);
    
    oneway void handleTransRequestPending(in RequestRef request);
    
    oneway void handleTransRequestResponse(in RequestRef         ref,
					   in Status             result,
                                           in boolean            requireAck,
                                           in ActionReplies      userReply);
  };

#endif // _CLIENT2SERVER_

  //////////////////////////////////////////////////////////////////
  // Session user
  //////////////////////////////////////////////////////////////////

#ifdef _SERVER2CLIENT_

  interface SessionUser {

    //////////////////////////////////////////////////
    // Resplies from Factory
    //////////////////////////////////////////////////

    oneway void startSessionResponse(in RequestRef  ref,
                                     in Status      result,
                                     in SessionRef  session);
    
    oneway void sessionsResponse(in RequestRef      ref,
                                 in Status          result,
                                 in SessionRefList  sessions);

    oneway void stopSessionResponse(in RequestRef  ref,
                                    in Status      result);
    
    //////////////////////////////////////////////////
    // SessionUser Requests
    //////////////////////////////////////////////////

    // Invoked when a new connection is established
    oneway void handleConnect(in RequestRef     ref,
                              in SessionRef     replyTo,
                              in ConnHandle     conn,
                              in unsigned short protocolVersion);

    // Invoked when a connection is teared down
    oneway void handleDisconnect(in RequestRef     ref,
                                 in SessionRef     replyTo,
                                 in ConnHandle     conn,
                                 in unsigned short protocolVersion,
                                 in string         discoReason);
  
    // Invoked when a received message had syntax errors
    oneway void handleSyntaxError(in RequestRef                     ref,
                                  in SessionRef                     replyTo,
                                  in ReceiveHandle                  rh,
                                  in unsigned short                 protocolVersion,
                                  in MegacoMessage::ErrorDescriptor defaultDesc);

    // Invoked when a received message just contains an error
    oneway void handleMessageError(in RequestRef                     ref,
                                   in SessionRef                     replyTo,
                                   in ConnHandle                     conn,
                                   in unsigned short                 protocolVersion,
                                   in MegacoMessage::ErrorDescriptor desc);

    // Invoked for each transaction request
    oneway void handleTransRequest(in RequestRef     ref,
                                   in SessionRef     replyTo,
                                   in ConnHandle     conn,
                                   in unsigned short protocolVersion,
                                   in ActionRequests actions);
  
    // Invoked for a transaction reply
    // Returns the reply from sendTransRequest/5
    // Parameters:
    // ref:     Same as given in the sendTransRequest function call
    // replyTo: Session identifier
    oneway void handleTransReply(in RequestRef     ref, // reuse RequestRef
                                 in SessionRef     replyTo,
                                 in ConnHandle     conn,
                                 in unsigned short protocolVersion,
				 in Status         result,
                                 in ActionReplies  userReply);

    // Optionally invoked for a transaction acknowledgement
    // Parameters:
    // ref:     Same as given in the sendTransRequest function call
    // replyTo: Session identifier
    oneway void handleTransAck(in RequestRef     ref,   
                               in SessionRef     replyTo,
                               in ConnHandle     conn,
                               in unsigned short protocolVersion,
                               in Status         result);

    // Invoked when  an unexpected message has been received
    oneway void handleUnexpectedTrans(in RequestRef     ref,
                                      in SessionRef     replyTo,
                                      in ConnHandle     conn,
                                      in unsigned short protocolVersion,
                                      in Transaction    trans);

    //////////////////////////////////////////////////
    // Responses from Session
    //////////////////////////////////////////////////

    oneway void systemInfoResponse(in RequestRef      ref,
                                   in Status          result,
                                   in SystemInfoValue value);

    oneway void startUserResponse(in RequestRef  ref,
                                  in Status      result);
  
    oneway void stopUserResponse(in RequestRef  ref,
                                 in Status      result);
  
   
    oneway void userInfoResponse(in RequestRef    ref,
                                 in Status        result,
                                 in UserInfoValue value);
  
    oneway void updateUserInfoResponse(in RequestRef ref,
                                       in Status     result);
  
    oneway void connInfoResponse(in RequestRef    ref,
                                 in Status        result,
                                 in ConnInfoValue value);
  
    oneway void updateConnInfoResponse(in RequestRef  ref,
                                       in Status      result);
  
    oneway void connectResponse(in RequestRef  ref,
                                in Status      result,
                                in ConnHandle  conn);

    oneway void disconnectResponse(in RequestRef  ref,
                                   in Status      result);
  
    oneway void cancelResponse(in RequestRef  ref,
                               in Status      result);
  };
 
#endif // _SERVER2CLIENT_

  //////////////////////////////////////////////////////////////////
  // Factory
  //////////////////////////////////////////////////////////////////

#ifdef _CLIENT2SERVER_

  interface SessionFactory {
    
    // Start a session thread
    // auto_stop_user indocates whether a megaco user (mid) shall
    // automatically be stopped when the user node dies.
    oneway void startSession(in RequestRef       ref,
                             in SessionUserRef   replyTo,
			     in boolean          auto_stop_user);

    // List active session threads
    oneway void sessions(in RequestRef       ref,
                         in SessionUserRef   replyTo);

    // Stop a session thread
    oneway void stopSession(in RequestRef       ref,
                            in SessionUserRef   replyTo,
			    in SessionRef       session);
  };

#endif // _CLIENT2SERVER_

};

#endif /* ifndef _MEGACOSESSION_IDL_ */