blob: 77ee105951586cdaea268edb2c2c69750415ad93 [file] [log] [blame]
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
<head>
</head>
<body>
The protocol layer is the central place for handling the fundamental logic and assertions of XMPP stanzas going over a XMPP transport.
The protocol layer normally gets fed from the transport layer, but is independent from it (to be easily testable and
keeping transports pluggable).
<p/>
To execute actual command functionality, the protocol layer looks up (using {@link org.apache.vysper.xmpp.protocol.StanzaHandlerLookup})
and hands over control to the appropriate {@link org.apache.vysper.xmpp.protocol.StanzaHandler}.
It acts as a state machine for a {@link org.apache.vysper.xmpp.server.SessionContext}.
<p/>
Essentially, the protocol layer ensures that every XMPP session is in a well-defined state, the fundamental rules of stanza processing are
followed, that the appropriate handlers are called and session, transport and connection are working well together.
It knows what to do when a session gets closed (unexectedly or expectedly) and handles stream level errors.
@see org.apache.vysper.xmpp.protocol.ProtocolWorker
@see org.apache.vysper.xmpp.stanza.Stanza
@see org.apache.vysper.xmpp.protocol.StanzaHandlerLookup
@see org.apache.vysper.xmpp.protocol.StanzaHandler
@see org.apache.vysper.xmpp.protocol.StateAwareProtocolWorker
</body>
</html>