private void OnReceive(IAsyncResult ar)
{
List <SipMessage> received = null;
try
{
using (TimedLock.Lock(transport))
{
int cb;
int pos;
int cbContents;
SipHeader contentLength;
byte[] packet;
try
{
if (sock == null)
{
return;
}
if (contentBuf == null)
{
// We're reading a message envelope.
// Read packets into headerBuf until we can find the CRLFCRLF
// sequence marking the end of the message headers.
cb = sock.EndReceive(ar);
if (cb == 0)
{
// The socket has been closed on by the remote element.
CloseAndRemove();
return;
}
cbRecv += cb;
tryAgain:
// Remove any leading CR or LF characters by shifting the
// buffer contents. I know this isn't super efficient but
// we'll probably never actually see packets with this
// in the wild.
for (pos = 0; pos < cbRecv; pos++)
{
if (headerBuf[pos] != 0x0D && headerBuf[pos] != 0x0A)
{
break;
}
}
if (pos != 0)
{
if (pos == cbRecv)
{
// No data remaining in the buffer
cbRecv = 0;
sock.BeginReceive(headerBuf, 0, headerBuf.Length, SocketFlags.None, onRecv, null);
return;
}
Array.Copy(headerBuf, pos, headerBuf, 0, headerBuf.Length - pos);
cbRecv -= pos;
}
// Scan the message for the CRLFCRLF sequence terminating the
// message envelope.
pos = Helper.IndexOf(headerBuf, CRLFCRLF, 0, cbRecv);
if (pos != -1)
{
// We've got the message envelope
pos += 4; // Advance past the CRLFCRLF
// Parse the message headers and then get the Content-Length header
packet = Helper.Extract(headerBuf, 0, pos);
try
{
message = SipMessage.Parse(packet, false);
}
catch (Exception e)
{
SipHelper.Trace(string.Format("TCP: UNPARSABLE message received from {0}: [{1}]", remoteEP, e.Message), Helper.FromUTF8(packet));
throw;
}
contentLength = message[SipHeader.ContentLength];
if (contentLength == null || !int.TryParse(contentLength.Text, out cbContents) || cbContents < 0)
{
var e = new SipException("Malformed SIP message: Invalid or missing [Content-Length] header from streaming transport.");
e.Transport = "TCP";
e.BadPacket = packet;
e.SourceEndpoint = remoteEP;
throw e;
}
if (cbContents > MaxContentSize)
{
var e = new SipException("Invalid SIP message: [Content-Length={0}] exceeds [{1}].", cbContents, MaxContentSize);
e.Transport = "TCP";
e.BadPacket = packet;
e.SourceEndpoint = remoteEP;
throw e;
}
if (pos + cbContents <= cbRecv)
{
// We already have the message contents, so extract the contents,
// add them to the message, and then queue the message for delivery
// once we leave the lock.
message.Contents = Helper.Extract(headerBuf, pos, cbContents);
if (received == null)
{
received = new List <SipMessage>();
}
received.Add(message);
message = null;
// Shift any remaining data to the left in headerBuf,
// adjust cbRecv, and the loop to look for another
// message.
pos += cbContents;
cb = cbRecv - pos; // Bytes remaining in the buffer
if (cb == 0)
{
// No more data left in the buffer
cbRecv = 0;
sock.BeginReceive(headerBuf, 0, headerBuf.Length, SocketFlags.None, onRecv, null);
return;
}
Array.Copy(headerBuf, pos, headerBuf, 0, cb);
cbRecv = cb;
goto tryAgain;
}
// We don't have all of the message contents, so allocate a buffer for
// the contents, copy what we have already into this buffer, and then
// initiate a receive operation to read the remaining data.
contentBuf = new byte[cbContents];
cbRecv = cbRecv - pos; // Content bytes remaining in the buffer
Array.Copy(headerBuf, pos, contentBuf, 0, cbRecv);
sock.BeginReceiveAll(contentBuf, cbRecv, cbContents - cbRecv, SocketFlags.None, onRecv, null);
return;
}
// Throw an error if the header buffer is full and we still haven't
// found the end of the envelope.
if (cbRecv >= headerBuf.Length)
{
var e = new SipException("Malformed SIP message: Read [{0}] bytes and have not yet encountered end of headers.", headerBuf.Length);
e.Transport = "TCP";
e.SourceEndpoint = remoteEP;
throw e;
}
// Continue receiving header data.
sock.BeginReceive(headerBuf, cbRecv, headerBuf.Length - cbRecv, SocketFlags.None, onRecv, null);
}
else
{
// We're in the process of reading the message contents.
// Complete the contents receive operation and queue the
// message for delivery after we leave the lock.
sock.EndReceiveAll(ar);
message.Contents = contentBuf;
if (received == null)
{
received = new List <SipMessage>();
}
received.Add(message);
// Reset and start reading the next message envelope.
message = null;
contentBuf = null;
cbRecv = 0;
sock.BeginReceive(headerBuf, 0, headerBuf.Length, SocketFlags.None, onRecv, null);
}
}
catch (SocketException)
{
CloseAndRemove();
}
catch (Exception e)
{
SysLog.LogException(e);
CloseAndRemove();
}
}
}
finally
{
// Deliver any queued messages (outside of the lock)
if (received != null)
{
foreach (var message in received)
{
message.SourceTransport = transport;
message.RemoteEndpoint = remoteEP;
if ((transport.traceMode & SipTraceMode.Receive) != 0)
{
SipHelper.Trace(string.Format("TCP: received from {0}", remoteEP), message);
}
transport.router.Route(transport, message);
}
}
}
}
/// <summary>
/// The managing <see cref="ISipAgent" /> is responsible for calling this
/// method whenever it receives requests correlated to this transaction.
/// </summary>
/// <param name="request">The received <see cref="SipRequest" />.</param>
public void OnRequest(SipRequest request)
{
SipRequest callbackMsg = null;
bool callOnRequest = false;
bool callOnInviteBegin = false;
bool callOnInviteComplete = false;
try
{
request.SourceTransaction = this;
using (TimedLock.Lock(agent))
{
if (this.request == null)
{
SipViaValue viaValue;
SipContactValue toValue;
NetworkBinding sentBy;
IPAddress address;
// This is the initial transaction request.
this.request = request;
// Handle the Via "received" and "rport" header parameters (mostly) as described on page
// RFC 3261 (page 145) and RFC 3581 (page 4).
viaValue = request.GetHeader <SipViaValue>(SipHeader.Via);
if (viaValue == null)
{
// Illegal request
SetState(SipTransactionState.Terminated);
return;
}
sentBy = viaValue.SentByBinding;
if (sentBy == null || sentBy.IsHost || sentBy.Address != request.RemoteEndpoint.Address)
{
viaValue.Received = request.RemoteEndpoint.Address.ToString();
}
if (viaValue.RPort != null)
{
viaValue.RPort = request.RemoteEndpoint.Port.ToString();
}
// Determine the destination network endpoint based on the
// rules described on RFC 3261 (page 146).
if (request.SourceTransport.IsStreaming)
{
// $todo(jeff.lill):
//
// This implementation is incomplete. To be fully
// compliant with the RFC, I'd have to check to
// see if the connection is still present in the
// transport and if not, use the received and
// rport values as described.
remoteEP = request.RemoteEndpoint;
}
else
{
if (viaValue.MAddr != null)
{
if (!IPAddress.TryParse(viaValue.MAddr, out address))
{
SipException e;
// Illegal request
SetState(SipTransactionState.Terminated);
e = new SipException("Illegal request: Invalid [Via: maddr].");
e.Transport = transport.Name;
e.SourceEndpoint = request.RemoteEndpoint;
e.BadMessage = request;
throw e;
}
remoteEP = new NetworkBinding(address, viaValue.SentByBinding.Port);
}
else
{
remoteEP = request.RemoteEndpoint;
}
}
// INVITE and non-INVITE requests have different state machines.
if (request.Method == SipMethod.Invite)
{
// Start an INVITE transaction
SetState(SipTransactionState.InviteProceeding);
// If the request has a "To" header without a "tag" parameter then
// generate a tag. Note that this code will cause provisional INVITE
// responses to include a generated tag which the RFC indicates
// SHOULD NOT be done. But, it's much safer to do this once here
// for all transaction types, avoiding special cases, and besides,
// I've noticed that Asterisk includes a tag in its provisional
// INVITE responses.
toValue = request.GetHeader <SipContactValue>(SipHeader.To);
if (toValue != null)
{
if (toValue["tag"] == null)
{
toValue["tag"] = SipHelper.GenerateTagID();
}
request.SetHeader(SipHeader.To, toValue);
}
// Always send an initial provisional trying response.
provisionalResponse = request.CreateResponse(SipStatus.Trying, null);
SendResponse(provisionalResponse);
// Setup to call the agent's OnInviteBegin() method.
callOnInviteBegin = true;
callbackMsg = request;
}
else if (request.Method == SipMethod.Ack)
{
// Allow an ACK request to drop through to the state machine.
}
else
{
// Start a non-INVITE transaction
SetState(SipTransactionState.Trying);
// Setup to call the agent's OnRequest() method.
callOnRequest = true;
callbackMsg = request;
}
return;
}
// Handle state specific processing
switch (base.State)
{
default:
case SipTransactionState.Unknown:
SysLog.LogError("Unexpected SIP transaction state.");
SetState(SipTransactionState.Terminated);
return;
case SipTransactionState.InviteCalling:
break;
case SipTransactionState.InviteProceeding:
if (provisionalResponse != null)
{
transport.Send(remoteEP, provisionalResponse);
}
break;
case SipTransactionState.InviteCompleted:
if (request.Method == SipMethod.Ack)
{
SetState(SipTransactionState.InviteConfirmed);
// Setup to call OnInviteComplete(ack);
callOnInviteComplete = true;
callbackMsg = request;
return;
}
Assertion.Test(finalResponse != null);
transport.Send(remoteEP, finalResponse);
break;
case SipTransactionState.InviteConfirmed:
break;
case SipTransactionState.Trying:
break;
case SipTransactionState.Proceeding:
Assertion.Test(provisionalResponse != null);
transport.Send(remoteEP, provisionalResponse);
break;
case SipTransactionState.Completed:
Assertion.Test(finalResponse != null);
transport.Send(remoteEP, finalResponse);
break;
case SipTransactionState.Terminated:
break;
}
}
}
finally
{
// Handle the agent callbacks outside of the lock to avoid
// deadlock issues.
if (callOnRequest)
{
agent.OnRequest(this, callbackMsg);
}
if (callOnInviteBegin)
{
agent.OnInviteBegin(this, request);
}
if (callOnInviteComplete)
{
agent.OnInviteComplete(this, this.request, finalResponse, callbackMsg);
}
}
}
/// <summary>
/// Called when a packet is received by the socket from a remote endpoint.
/// </summary>
/// <param name="ar">The <see cref="IAsyncResult" />.</param>
private void OnReceive(IAsyncResult ar)
{
byte[] packet = null;
IPEndPoint remoteEP = new IPEndPoint(IPAddress.Any, 0);
int cb;
SipMessage message;
recvPending = false;
if (sock == null || recvBuf == null)
{
return;
}
try
{
cb = sock.EndReceiveFrom(ar, ref recvEP);
}
catch (Exception e)
{
// Log the exception if the socket appears to be open and then submit
// another receive request.
if (sock.IsOpen)
{
SysLog.LogException(e);
try
{
recvEP = new IPEndPoint(IPAddress.Any, 0);
sock.BeginReceiveFrom(recvBuf, 0, recvBuf.Length, SocketFlags.None, ref recvEP, onRecv, null);
}
catch (Exception e2)
{
SysLog.LogException(e2, "SIP UDP transport is no longer able to receive packets.");
}
}
return;
}
// $todo(jeff.lill): This is where I need to add source filtering.
// Make a copy of what we received before initiating the next packet receive.
try
{
packet = Helper.Extract(recvBuf, 0, cb);
remoteEP = (IPEndPoint)recvEP;
}
catch (Exception e)
{
SysLog.LogException(e);
}
// Initiate the receive of the next message
lock (syncLock)
{
if (sock == null || !sock.IsOpen)
{
return;
}
try
{
recvEP = new IPEndPoint(IPAddress.Any, 0);
recvPending = true;
sock.BeginReceiveFrom(recvBuf, 0, recvBuf.Length, SocketFlags.None, ref recvEP, onRecv, null);
}
catch (Exception e)
{
SysLog.LogException(e);
}
}
// Parse and dispatch the message
if (packet == null)
{
return;
}
// It looks like SIP clients like X-Lite send 4 byte CRLF CRLF messages
// periodically over UDP to keep NAT mappings alive. I'm going to
// ignore these messages.
if (packet.Length == 4)
{
return;
}
// Looks like we have a real message.
try
{
try
{
message = SipMessage.Parse(packet, true);
}
catch (Exception e)
{
SipHelper.Trace(string.Format("UDP: UNPARSABLE message received from {0}: [{1}]", remoteEP, e.Message), Helper.FromUTF8(packet));
throw;
}
message.SourceTransport = this;
message.RemoteEndpoint = remoteEP;
}
catch (SipException e)
{
e.BadPacket = packet;
e.SourceEndpoint = remoteEP;
SysLog.LogException(e);
return;
}
catch (Exception e)
{
SipException sipException;
sipException = new SipException("Error parsing SIP message.", e);
sipException.Transport = string.Format("UDP [{0}]", localEP);
sipException.BadPacket = packet;
sipException.SourceEndpoint = remoteEP;
SysLog.LogException(sipException);
return;
}
if (disabled)
{
return;
}
if ((traceMode & SipTraceMode.Receive) != 0)
{
SipHelper.Trace(string.Format("UDP: received from {0}", remoteEP), message);
}
router.Route(this, message);
}