#include "sockets.h"
#include "beepsession.h"
#include "beepmessage.h"
Go to the source code of this file.
Compounds | |
| struct | sbChanObject |
| The BEEP channel object. More... | |
Defines | |
| #define | __LIB3195_BEEPCHANNEL_H_INCLUDED__ 1 |
| #define | SBCHAN_INVALID_CHANNEL -1 |
| Invalid channel number (no valid channel value). | |
| #define | sbChanCHECKVALIDOBJECT(x) {assert((x) != NULL); assert((x)->OID == OIDsbChan); assert((x)->iState != sbChan_STATE_INVALID);} |
Typedefs | |
| typedef enum sbChannelState_ | sbChannelState |
| typedef sbChanObject | sbChanObj |
Enumerations | |
| enum | sbChannelState_ { sbChan_STATE_INVALID = 0, sbChan_STATE_INITIALIZED, sbChan_STATE_OPEN, sbChan_STATE_AWAITING_CLOSE, sbChan_STATE_PENDING_CLOSE, sbChan_STATE_CLOSED, sbChan_STATE_BROKEN, sbChan_STATE_ERR_FREE_NEEDED } |
| return value. More... | |
Functions | |
| srRetVal | sbChanSetChanno (sbChanObj *pThis, int iChanno) |
| Set the channel number for this channel (done by channel 0 profile). | |
| sbChanObj * | sbChanConstruct (struct sbSessObject *pSess) |
| sbChan Constructor. | |
| srRetVal | sbChanSendMesg (sbChanObj *pThis, struct sbMesgObject *pMesg, char *pszCmd) |
| Send a BEEP frame on this channel. | |
| srRetVal | sbChanActualSendFram (sbChanObj *pThis, struct sbFramObject *pFram) |
| Actually send the frame over the channel. | |
| void | sbChanDestroy (sbChanObj *pThis) |
| Destructor. | |
| srRetVal | sbChanUpdateChannelState (sbChanObj *pThis, int iNewState) |
| Update the channel status. | |
| srRetVal | sbChanAssignProfile (sbChanObj *pThis, struct sbProfObject *pProf) |
| Assign a profile to this channel. | |
| void | sbChanAbort (sbChanObj *pThis) |
| Aborts a channel. | |
| srRetVal | sbChanSendErrResponse (sbChanObj *pThis, unsigned uErrCode, char *pszErrMsg) |
| Send an error response to the remote peer. | |
| srRetVal | sbChanSetAwaitingClose (sbChanObj *pThis) |
| Set the channel status to "awaiting close". | |
| srRetVal | sbChanSendSEQ (sbChanObj *pThis, unsigned uAckno, unsigned uWindow) |
| Send a SEQ frame for the current channel. | |
| srRetVal | sbChanSendOK (sbChanObj *pThis, void(*OnFrameDestroy)(struct sbFramObject *), void *pUsr) |
| Send an OK on the associated channel. | |
| srRetVal | sbChanSetChanClosed (sbChanObj *pThis) |
| Set channel state to closed. | |
2003-09-04 Updated to support multiple client profiles.
2003-09-08 Added support for sending SEQs in reply to the server's response.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the names of Adiscon GmbH, Rainer Gerhards nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
Aborts a channel. That is, it destroys the channel object itself but DOES NOT remove it from the session's linked list of channels. |
|
||||||||||||
|
Actually send the frame over the channel. We need to first check if the frame is within the current Window and - if not - we need to return immediately to the caller. The session layer will then handle the rest. For full details on the send process, see architecture::c
|
|
||||||||||||
|
Assign a profile to this channel. Only one profile can be assigned to a channel at one time. As such, no profile is allowed to be already assigned when this method is called. Once the profile object has been assigned to the channel, the channel "owns" it. That means the caller is not allowed to use it any longer or free() it. The channel will free it when the channel is destroyed.
|
|
|
sbChan Constructor.
|
|
|
Destructor. The channel object itself will be freed and can not be used any longer. |
|
||||||||||||||||
|
Send an error response to the remote peer.
|
|
||||||||||||||||
|
Send a BEEP frame on this channel. The message provided as parameter is sent over the channel. This method here performs all necessary processing, including conversion from Mesg to (eventually multiple) frames.
|
|
||||||||||||||||
|
Send an OK on the associated channel. This is just a shortcut to save some typing. |
|
||||||||||||||||
|
Send a SEQ frame for the current channel.
|
|
||||||||||||
|
Set the channel number for this channel (done by channel 0 profile). IMPORTANT: the channel number MUST be set only ONCE and this BEFORE any data is sent or received over the channel. The reason for this is that this method also adds the channel to session's list of channel objects. If it would be called multiple times, multiple copies would be present in the list - which would (mildly said) cause unpredictable results). Of course, we could change the behaviour to handle this case, but I do not see any good reason for this. So far, it looks like a waste of CPU cycles...
|
|
||||||||||||
|
Update the channel status.
|
1.3.2