/protocols/smpp/src/main/java/org/mobicents/protocols/smpp/event/SMPPEvent.java

 1/*
 2 * JBoss, Home of Professional Open Source
 3 * Copyright 2011, Red Hat, Inc. and individual contributors
 4 * by the @authors tag. See the copyright.txt in the distribution for a
 5 * full listing of individual contributors.
 6 *
 7 * This is free software; you can redistribute it and/or modify it
 8 * under the terms of the GNU Lesser General Public License as
 9 * published by the Free Software Foundation; either version 2.1 of
10 * the License, or (at your option) any later version.
11 *
12 * This software is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this software; if not, write to the Free
19 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21 */
22
23package org.mobicents.protocols.smpp.event;
24
25import org.mobicents.protocols.smpp.Session;
26
27/**
28 * Abstract super class of SMPP control events.
29 * 
30 * @version $Id: SMPPEvent.java 452 2009-01-15 16:56:36Z orank $
31 */
32public abstract class SMPPEvent {
33    /** ReceiverStartEvent enumeration type. */
34    public static final int RECEIVER_START = 2;
35
36    /** ReceiverExitEvent enumeration type. */
37    public static final int RECEIVER_EXIT = 3;
38
39    /** ReceiverExceptionEvent enumeration type. */
40    public static final int RECEIVER_EXCEPTION = 4;
41
42    /** The source Connection of this event. */
43    private Session source;
44
45    /** The type of this event. */
46    private int type;
47
48    /**
49     * Construct a new event. The <code>type</code> parameter should match one
50     * of the enumeration constants defined in this class.
51     */
52    protected SMPPEvent(int type, Session source) {
53        this.source = source;
54        this.type = type;
55    }
56
57    /**
58     * Get the source connection of this event.
59     */
60    public Session getSource() {
61        return source;
62    }
63
64    /**
65     * Get the enumeration type of this event.
66     * 
67     * @see #RECEIVER_EXIT
68     * @see #RECEIVER_EXCEPTION
69     */
70    public int getType() {
71        return type;
72    }
73}
74