/// <summary>
/// Attempts to create a client TCP socket connection to a remote end point.
/// </summary>
/// <param name="dstEndPoint">The remote TCP end point to attempt to connect to.</param>
/// <param name="buffer">An optional buffer that if set can contain data to transmit immediately after connecting.</param>
/// <returns>If successful a connected client socket or null if not.</returns>
public async Task <SocketError> ConnectClientAsync(IPEndPoint dstEndPoint, byte[] buffer, string serverCertificateName)
{
try
{
// No existing TCP connection to the destination. Attempt a new socket connection.
IPAddress localAddress = ListeningIPAddress;
if (ListeningIPAddress == IPAddress.Any)
{
localAddress = NetServices.GetLocalAddressForRemote(dstEndPoint.Address);
}
IPEndPoint localEndPoint = new IPEndPoint(localAddress, Port);
logger.LogDebug($"ConnectAsync SIP {ProtDescr} Channel local end point of {localEndPoint} selected for connection to {dstEndPoint}.");
Socket clientSocket = new Socket(dstEndPoint.AddressFamily, SocketType.Stream, ProtocolType.Tcp);
clientSocket.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.ReuseAddress, true);
clientSocket.LingerState = new LingerOption(true, 0);
clientSocket.Bind(localEndPoint);
SocketAsyncEventArgs connectArgs = new SocketAsyncEventArgs
{
RemoteEndPoint = dstEndPoint
};
// If this is a TCP channel can take a shortcut and set the first send payload on the connect args.
if (buffer != null && buffer.Length > 0 && serverCertificateName == null)
{
connectArgs.SetBuffer(buffer, 0, buffer.Length);
}
logger.LogDebug($"Attempting TCP connection from {localEndPoint} to {dstEndPoint}.");
// Attempt to connect.
TaskCompletionSource <SocketError> connectTcs = new TaskCompletionSource <SocketError>();
connectArgs.Completed += (sender, sockArgs) =>
{
if (sockArgs.LastOperation == SocketAsyncOperation.Connect)
{
connectTcs.SetResult(sockArgs.SocketError);
}
};
bool willRaiseEvent = clientSocket.ConnectAsync(connectArgs);
if (!willRaiseEvent)
{
if (connectArgs.LastOperation == SocketAsyncOperation.Connect)
{
connectTcs.SetResult(connectArgs.SocketError);
}
}
var connectResult = await connectTcs.Task;
logger.LogDebug($"ConnectAsync SIP {ProtDescr} Channel connect completed result for {localEndPoint}->{dstEndPoint} {connectResult}.");
if (connectResult != SocketError.Success)
{
logger.LogWarning($"SIP {ProtDescr} Channel send to {dstEndPoint} failed. Attempt to create a client socket failed.");
}
else
{
SIPStreamConnection sipStmConn = new SIPStreamConnection(clientSocket, clientSocket.RemoteEndPoint as IPEndPoint, SIPProtocol);
sipStmConn.SIPMessageReceived += SIPTCPMessageReceived;
m_connections.TryAdd(sipStmConn.ConnectionID, sipStmConn);
await OnClientConnect(sipStmConn, buffer, serverCertificateName);
}
return(connectResult);
}
catch (Exception excp)
{
logger.LogError($"Exception ConnectClientAsync. {excp.Message}");
return(SocketError.Fault);
}
}
static void Main(string[] args)
{
Console.WriteLine("SIPSorcery user agent server example.");
Console.WriteLine("Press h to hangup a call or ctrl-c to exit.");
EnableConsoleLogger();
IPAddress listenAddress = IPAddress.Any;
IPAddress listenIPv6Address = IPAddress.IPv6Any;
if (args != null && args.Length > 0)
{
if (!IPAddress.TryParse(args[0], out var customListenAddress))
{
Log.LogWarning($"Command line argument could not be parsed as an IP address \"{args[0]}\"");
listenAddress = IPAddress.Any;
}
else
{
if (customListenAddress.AddressFamily == AddressFamily.InterNetwork)
{
listenAddress = customListenAddress;
}
if (customListenAddress.AddressFamily == AddressFamily.InterNetworkV6)
{
listenIPv6Address = customListenAddress;
}
}
}
// Set up a default SIP transport.
var sipTransport = new SIPTransport();
var localhostCertificate = new X509Certificate2("localhost.pfx");
// IPv4 channels.
sipTransport.AddSIPChannel(new SIPUDPChannel(new IPEndPoint(listenAddress, SIP_LISTEN_PORT)));
sipTransport.AddSIPChannel(new SIPTCPChannel(new IPEndPoint(listenAddress, SIP_LISTEN_PORT)));
sipTransport.AddSIPChannel(new SIPTLSChannel(localhostCertificate, new IPEndPoint(listenAddress, SIPS_LISTEN_PORT)));
sipTransport.AddSIPChannel(new SIPWebSocketChannel(IPAddress.Any, SIP_WEBSOCKET_LISTEN_PORT));
sipTransport.AddSIPChannel(new SIPWebSocketChannel(IPAddress.Any, SIP_SECURE_WEBSOCKET_LISTEN_PORT, localhostCertificate));
// IPv6 channels.
sipTransport.AddSIPChannel(new SIPUDPChannel(new IPEndPoint(listenIPv6Address, SIP_LISTEN_PORT)));
sipTransport.AddSIPChannel(new SIPTCPChannel(new IPEndPoint(listenIPv6Address, SIP_LISTEN_PORT)));
sipTransport.AddSIPChannel(new SIPTLSChannel(localhostCertificate, new IPEndPoint(listenIPv6Address, SIPS_LISTEN_PORT)));
sipTransport.AddSIPChannel(new SIPWebSocketChannel(IPAddress.IPv6Any, SIP_WEBSOCKET_LISTEN_PORT));
sipTransport.AddSIPChannel(new SIPWebSocketChannel(IPAddress.IPv6Any, SIP_SECURE_WEBSOCKET_LISTEN_PORT, localhostCertificate));
EnableTraceLogs(sipTransport);
// To keep things a bit simpler this example only supports a single call at a time and the SIP server user agent
// acts as a singleton
SIPServerUserAgent uas = null;
CancellationTokenSource rtpCts = null; // Cancellation token to stop the RTP stream.
RTPMediaSession rtpSession = null;
// Because this is a server user agent the SIP transport must start listening for client user agents.
sipTransport.SIPTransportRequestReceived += async(SIPEndPoint localSIPEndPoint, SIPEndPoint remoteEndPoint, SIPRequest sipRequest) =>
{
try
{
if (sipRequest.Method == SIPMethodsEnum.INVITE)
{
SIPSorcery.Sys.Log.Logger.LogInformation($"Incoming call request: {localSIPEndPoint}<-{remoteEndPoint} {sipRequest.URI}.");
// Check there's a codec we support in the INVITE offer.
var offerSdp = SDP.ParseSDPDescription(sipRequest.Body);
IPEndPoint dstRtpEndPoint = SDP.GetSDPRTPEndPoint(sipRequest.Body);
string audioFile = null;
if (offerSdp.Media.Any(x => x.Media == SDPMediaTypesEnum.audio && x.HasMediaFormat((int)SDPMediaFormatsEnum.G722)))
{
Log.LogDebug($"Using G722 RTP media type and audio file {AUDIO_FILE_G722}.");
rtpSession = new RTPMediaSession(SDPMediaTypesEnum.audio, (int)SDPMediaFormatsEnum.G722, dstRtpEndPoint.AddressFamily);
audioFile = AUDIO_FILE_G722;
}
else if (offerSdp.Media.Any(x => x.Media == SDPMediaTypesEnum.audio && x.HasMediaFormat((int)SDPMediaFormatsEnum.PCMU)))
{
Log.LogDebug($"Using PCMU RTP media type and audio file {AUDIO_FILE_PCMU}.");
rtpSession = new RTPMediaSession(SDPMediaTypesEnum.audio, (int)SDPMediaFormatsEnum.PCMU, dstRtpEndPoint.AddressFamily);
audioFile = AUDIO_FILE_PCMU;
}
if (rtpSession == null)
{
// Didn't get a match on the codecs we support.
SIPResponse noMatchingCodecResponse = SIPResponse.GetResponse(sipRequest, SIPResponseStatusCodesEnum.NotAcceptableHere, null);
await sipTransport.SendResponseAsync(noMatchingCodecResponse);
}
else
{
// If there's already a call in progress hang it up. Of course this is not ideal for a real softphone or server but it
// means this example can be kept simpler.
if (uas?.IsHungup == false)
{
uas?.Hangup(false);
}
rtpCts?.Cancel();
rtpCts = new CancellationTokenSource();
UASInviteTransaction uasTransaction = new UASInviteTransaction(sipTransport, sipRequest, null);
uas = new SIPServerUserAgent(sipTransport, null, null, null, SIPCallDirection.In, null, null, null, uasTransaction);
uas.CallCancelled += (uasAgent) =>
{
rtpCts?.Cancel();
rtpSession.CloseSession(null);
};
rtpSession.OnRtpClosed += (reason) => uas?.Hangup(false);
uas.Progress(SIPResponseStatusCodesEnum.Trying, null, null, null, null);
uas.Progress(SIPResponseStatusCodesEnum.Ringing, null, null, null, null);
// The RTP socket is listening on IPAddress.Any but the IP address placed into the SDP needs to be one the caller can reach.
IPAddress rtpAddress = NetServices.GetLocalAddressForRemote(dstRtpEndPoint.Address);
// Only set the remote RTP end point if there hasn't already been a packet received on it.
if (rtpSession.DestinationEndPoint == null)
{
rtpSession.SetRemoteSDP(SDP.ParseSDPDescription(sipRequest.Body));
Log.LogDebug($"Remote RTP socket {rtpSession.DestinationEndPoint}.");
}
rtpSession.SetRemoteSDP(SDP.ParseSDPDescription(sipRequest.Body));
_ = Task.Run(() => SendRtp(rtpSession, dstRtpEndPoint, audioFile, rtpCts))
.ContinueWith(_ =>
{
if (uas?.IsHungup == false)
{
uas?.Hangup(false);
rtpSession?.CloseSession(null);
}
});
uas.Answer(SDP.SDP_MIME_CONTENTTYPE, rtpSession.GetSDP(rtpAddress).ToString(), null, SIPDialogueTransferModesEnum.NotAllowed);
}
}
else if (sipRequest.Method == SIPMethodsEnum.BYE)
{
SIPSorcery.Sys.Log.Logger.LogInformation("Call hungup.");
SIPResponse byeResponse = SIPResponse.GetResponse(sipRequest, SIPResponseStatusCodesEnum.Ok, null);
await sipTransport.SendResponseAsync(byeResponse);
uas?.Hangup(true);
rtpSession?.CloseSession(null);
rtpCts?.Cancel();
}
else if (sipRequest.Method == SIPMethodsEnum.SUBSCRIBE)
{
SIPResponse notAllowededResponse = SIPResponse.GetResponse(sipRequest, SIPResponseStatusCodesEnum.MethodNotAllowed, null);
await sipTransport.SendResponseAsync(notAllowededResponse);
}
else if (sipRequest.Method == SIPMethodsEnum.OPTIONS || sipRequest.Method == SIPMethodsEnum.REGISTER)
{
SIPResponse optionsResponse = SIPResponse.GetResponse(sipRequest, SIPResponseStatusCodesEnum.Ok, null);
await sipTransport.SendResponseAsync(optionsResponse);
}
}
catch (Exception reqExcp)
{
SIPSorcery.Sys.Log.Logger.LogWarning($"Exception handling {sipRequest.Method}. {reqExcp.Message}");
}
};
ManualResetEvent exitMre = new ManualResetEvent(false);
Console.CancelKeyPress += delegate(object sender, ConsoleCancelEventArgs e)
{
e.Cancel = true;
SIPSorcery.Sys.Log.Logger.LogInformation("Exiting...");
Hangup(uas).Wait();
rtpSession?.CloseSession(null);
rtpCts?.Cancel();
if (sipTransport != null)
{
SIPSorcery.Sys.Log.Logger.LogInformation("Shutting down SIP transport...");
sipTransport.Shutdown();
}
exitMre.Set();
};
// Task to handle user key presses.
Task.Run(() =>
{
try
{
while (!exitMre.WaitOne(0))
{
var keyProps = Console.ReadKey();
if (keyProps.KeyChar == 'h' || keyProps.KeyChar == 'q')
{
Console.WriteLine();
Console.WriteLine("Hangup requested by user...");
Hangup(uas).Wait();
rtpSession?.CloseSession(null);
rtpCts?.Cancel();
}
if (keyProps.KeyChar == 'q')
{
SIPSorcery.Sys.Log.Logger.LogInformation("Quitting...");
if (sipTransport != null)
{
SIPSorcery.Sys.Log.Logger.LogInformation("Shutting down SIP transport...");
sipTransport.Shutdown();
}
exitMre.Set();
}
}
}
catch (Exception excp)
{
SIPSorcery.Sys.Log.Logger.LogError($"Exception Key Press listener. {excp.Message}.");
}
});
exitMre.WaitOne();
}
static void Main()
{
Console.WriteLine("SIPSorcery client user agent example.");
Console.WriteLine("Press ctrl-c to exit.");
// Plumbing code to facilitate a graceful exit.
CancellationTokenSource rtpCts = new CancellationTokenSource(); // Cancellation token to stop the RTP stream.
bool isCallHungup = false;
bool hasCallFailed = false;
AddConsoleLogger();
SIPURI callUri = SIPURI.ParseSIPURI(DEFAULT_DESTINATION_SIP_URI);
Log.LogInformation($"Call destination {callUri}.");
// Set up a default SIP transport.
var sipTransport = new SIPTransport();
sipTransport.AddSIPChannel(new SIPUDPChannel(new IPEndPoint(IPAddress.Any, 0)));
// Un/comment this line to see/hide each SIP message sent and received.
//EnableTraceLogs(sipTransport);
// Determine the local IP address to use for our RTP end point based on the address it will be sending to.
var lookupResult = sipTransport.GetURIEndPoint(callUri, false);
if (lookupResult != null)
{
var uasSIPEndPoint = lookupResult.GetSIPEndPoint();
IPAddress rtpAddress = NetServices.GetLocalAddressForRemote(uasSIPEndPoint.GetIPEndPoint().Address);
Log.LogInformation($"Call URI {callUri} resolved to {uasSIPEndPoint}.");
// Initialise an RTP session to receive the RTP packets from the remote SIP server.
Socket rtpSocket = null;
Socket controlSocket = null;
NetServices.CreateRtpSocket(rtpAddress, 49000, 49100, false, out rtpSocket, out controlSocket);
var rtpRecvSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
var rtpSendSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
// Create a client user agent to place a call to a remote SIP server along with event handlers for the different stages of the call.
var uac = new SIPClientUserAgent(sipTransport);
uac.CallTrying += (uac, resp) =>
{
Log.LogInformation($"{uac.CallDescriptor.To} Trying: {resp.StatusCode} {resp.ReasonPhrase}.");
Log.LogDebug(resp.ToString());
};
uac.CallRinging += (uac, resp) => Log.LogInformation($"{uac.CallDescriptor.To} Ringing: {resp.StatusCode} {resp.ReasonPhrase}.");
uac.CallFailed += (uac, err) =>
{
Log.LogWarning($"{uac.CallDescriptor.To} Failed: {err}");
hasCallFailed = true;
rtpCts.Cancel();
};
uac.CallAnswered += (uac, resp) =>
{
if (resp.Status == SIPResponseStatusCodesEnum.Ok)
{
Log.LogInformation($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
_remoteRtpEndPoint = SDP.GetSDPRTPEndPoint(resp.Body);
Log.LogDebug($"Remote RTP socket {_remoteRtpEndPoint}.");
}
else
{
Log.LogWarning($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
if (resp.StatusCode >= 400)
{
// Call failed.
hasCallFailed = true;
rtpCts.Cancel();
}
}
};
// The only incoming request that needs to be explicitly handled for this example is if the remote end hangs up the call.
sipTransport.SIPTransportRequestReceived += (SIPEndPoint localSIPEndPoint, SIPEndPoint remoteEndPoint, SIPRequest sipRequest) =>
{
if (sipRequest.Method == SIPMethodsEnum.BYE)
{
SIPNonInviteTransaction byeTransaction = sipTransport.CreateNonInviteTransaction(sipRequest, null);
SIPResponse byeResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.Ok, null);
byeTransaction.SendFinalResponse(byeResponse);
if (uac.IsUACAnswered)
{
Log.LogInformation("Call was hungup by remote server.");
isCallHungup = true;
rtpCts.Cancel();
}
}
};
// It's a good idea to start the RTP receiving socket before the call request is sent.
// A SIP server will generally start sending RTP as soon as it has processed the incoming call request and
// being ready to receive will stop any ICMP error response being generated.
Task.Run(() => RecvRtp(rtpSocket, rtpRecvSession, rtpCts));
Task.Run(() => SendRtp(rtpSocket, rtpSendSession, rtpCts));
// Start the thread that places the call.
SIPCallDescriptor callDescriptor = new SIPCallDescriptor(
SIPConstants.SIP_DEFAULT_USERNAME,
null,
callUri.ToString(),
SIPConstants.SIP_DEFAULT_FROMURI,
null, null, null, null,
SIPCallDirection.Out,
SDP.SDP_MIME_CONTENTTYPE,
GetSDP(rtpSocket.LocalEndPoint as IPEndPoint).ToString(),
null);
uac.Call(callDescriptor);
// Ctrl-c will gracefully exit the call at any point.
Console.CancelKeyPress += delegate(object sender, ConsoleCancelEventArgs e)
{
e.Cancel = true;
rtpCts.Cancel();
};
// At this point the call is established. We'll wait for a few seconds and then transfer.
// Note the empty ContinueWith is to catch and ignore the TaskCancelationExeption generated if
// rtpCts is set by the call failing.
Task.Delay(DELAY_UNTIL_TRANSFER_MILLISECONDS, rtpCts.Token).ContinueWith(tsk => { }).Wait();
if (!hasCallFailed)
{
SIPRequest referRequest = GetReferRequest(uac, SIPURI.ParseSIPURI(TRANSFER_DESTINATION_SIP_URI));
SIPNonInviteTransaction referTx = sipTransport.CreateNonInviteTransaction(referRequest, null);
referTx.NonInviteTransactionFinalResponseReceived += (SIPEndPoint localSIPEndPoint, SIPEndPoint remoteEndPoint, SIPTransaction sipTransaction, SIPResponse sipResponse) =>
{
if (sipResponse.Header.CSeqMethod == SIPMethodsEnum.REFER && sipResponse.Status == SIPResponseStatusCodesEnum.Accepted)
{
Log.LogInformation("Call transfer was accepted by remote server.");
isCallHungup = true;
rtpCts.Cancel();
}
};
referTx.SendReliableRequest();
}
// At this point the call transfer has been initiated and everything will be handled in an event handler or on the RTP
// receive task. The code below is to gracefully exit.
// Wait for a signal saying the call failed, was cancelled with ctrl-c or completed.
rtpCts.Token.WaitHandle.WaitOne();
Log.LogInformation("Exiting...");
rtpSocket?.Close();
controlSocket?.Close();
if (!isCallHungup && uac != null)
{
if (uac.IsUACAnswered)
{
Log.LogInformation($"Hanging up call to {uac.CallDescriptor.To}.");
uac.Hangup();
}
else if (!hasCallFailed)
{
Log.LogInformation($"Cancelling call to {uac.CallDescriptor.To}.");
uac.Cancel();
}
// Give the BYE or CANCEL request time to be transmitted.
Log.LogInformation("Waiting 1s for call to clean up...");
Task.Delay(1000).Wait();
}
}
SIPSorcery.Net.DNSManager.Stop();
if (sipTransport != null)
{
Log.LogInformation("Shutting down SIP transport...");
sipTransport.Shutdown();
}
}
static void Main()
{
Console.WriteLine("SIPSorcery client user agent example.");
Console.WriteLine("Press ctrl-c to exit.");
CancellationTokenSource exitCts = new CancellationTokenSource(); // Cancellation token to stop the SIP transport and RTP stream.
AddConsoleLogger();
// Set up a default SIP transport.
var sipTransport = new SIPTransport();
sipTransport.AddSIPChannel(new SIPUDPChannel(new IPEndPoint(IPAddress.Any, SIP_LISTEN_PORT)));
// Un/comment this line to see/hide each SIP message sent and received.
EnableTraceLogs(sipTransport);
// To keep things a bit simpler this example only supports a single call at a time and the SIP server user agent
// acts as a singleton
SIPUserAgent userAgent = new SIPUserAgent(sipTransport, null);
CancellationTokenSource rtpCts = null; // Cancellation token to stop the RTP stream.
Socket rtpSocket = null;
Socket controlSocket = null;
// Because this is a server user agent the SIP transport must start listening for client user agents.
sipTransport.SIPTransportRequestReceived += (SIPEndPoint localSIPEndPoint, SIPEndPoint remoteEndPoint, SIPRequest sipRequest) =>
{
try
{
if (sipRequest.Header.From != null &&
sipRequest.Header.From.FromTag != null &&
sipRequest.Header.To != null &&
sipRequest.Header.To.ToTag != null)
{
userAgent.InDialogRequestReceivedAsync(sipRequest).Wait();
}
if (sipRequest.Method == SIPMethodsEnum.INVITE)
{
SIPSorcery.Sys.Log.Logger.LogInformation($"Incoming call request: {localSIPEndPoint}<-{remoteEndPoint} {sipRequest.URI}.");
// Check there's a codec we support in the INVITE offer.
var offerSdp = SDP.ParseSDPDescription(sipRequest.Body);
IPEndPoint dstRtpEndPoint = SDP.GetSDPRTPEndPoint(sipRequest.Body);
RTPSession rtpSession = null;
string audioFile = null;
if (offerSdp.Media.Any(x => x.Media == SDPMediaTypesEnum.audio && x.HasMediaFormat((int)RTPPayloadTypesEnum.PCMU)))
{
Log.LogDebug($"Using PCMU RTP media type and audio file {AUDIO_FILE_PCMU}.");
rtpSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
audioFile = AUDIO_FILE_PCMU;
}
if (rtpSession == null)
{
// Didn't get a match on the codecs we support.
SIPResponse noMatchingCodecResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.NotAcceptableHere, null);
sipTransport.SendResponse(noMatchingCodecResponse);
}
else
{
// If there's already a call in progress hang it up. Of course this is not ideal for a real softphone or server but it
// means this example can be kept simpler.
if (userAgent?.IsAnswered == true)
{
userAgent?.Hangup();
}
rtpCts?.Cancel();
UASInviteTransaction uasTransaction = sipTransport.CreateUASTransaction(sipRequest, null);
if (userAgent.AcceptCall(uasTransaction))
{
rtpCts = new CancellationTokenSource();
// The RTP socket is listening on IPAddress.Any but the IP address placed into the SDP needs to be one the caller can reach.
IPAddress rtpAddress = NetServices.GetLocalAddressForRemote(dstRtpEndPoint.Address);
// Initialise an RTP session to receive the RTP packets from the remote SIP server.
NetServices.CreateRtpSocket(rtpAddress, RTP_PORT_START, RTP_PORT_END, false, out rtpSocket, out controlSocket);
var rtpRecvSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
var rtpSendSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
rtpSendSession.DestinationEndPoint = dstRtpEndPoint;
rtpRecvSession.OnReceiveFromEndPointChanged += (oldEP, newEP) =>
{
Log.LogDebug($"RTP destination end point changed from {oldEP} to {newEP}.");
rtpSendSession.DestinationEndPoint = newEP;
};
Task.Run(() => RecvRtp(rtpSocket, rtpRecvSession, rtpCts));
Task.Run(() => SendRtp(rtpSocket, rtpSendSession, rtpCts));
userAgent.Answer(GetSDP(rtpSocket.LocalEndPoint as IPEndPoint));
}
}
}
else if (sipRequest.Method == SIPMethodsEnum.SUBSCRIBE)
{
SIPResponse notAllowededResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.MethodNotAllowed, null);
sipTransport.SendResponse(notAllowededResponse);
}
else if (sipRequest.Method == SIPMethodsEnum.OPTIONS || sipRequest.Method == SIPMethodsEnum.REGISTER)
{
SIPResponse optionsResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.Ok, null);
sipTransport.SendResponse(optionsResponse);
}
}
catch (Exception reqExcp)
{
SIPSorcery.Sys.Log.Logger.LogWarning($"Exception handling {sipRequest.Method}. {reqExcp.Message}");
}
};
// Ctrl-c will gracefully exit the call at any point.
Console.CancelKeyPress += delegate(object sender, ConsoleCancelEventArgs e)
{
e.Cancel = true;
exitCts.Cancel();
rtpCts?.Cancel();
};
// At this point the call has been initiated and everything will be handled in an event handler.
Task.Run(async() =>
{
try
{
while (!exitCts.Token.WaitHandle.WaitOne(0))
{
var keyProps = Console.ReadKey();
if (keyProps.KeyChar == 't')
{
// Initiate a transfer.
bool transferResult = await userAgent.Transfer(SIPURI.ParseSIPURI(TRANSFER_DESTINATION_SIP_URI), new TimeSpan(0, 0, TRANSFER_TIMEOUT_SECONDS), exitCts.Token);
if (transferResult)
{
// If the transfer was accepted the original call will already have been hungup.
userAgent = null;
exitCts.Cancel();
}
else
{
Log.LogWarning($"Transfer to {TRANSFER_DESTINATION_SIP_URI} failed.");
}
}
else if (keyProps.KeyChar == 'q')
{
// Quit application.
exitCts.Cancel();
}
}
}
catch (Exception excp)
{
Log.LogError($"Exception Key Press listener. {excp.Message}.");
}
});
// Wait for a signal saying the call failed, was cancelled with ctrl-c or completed.
exitCts.Token.WaitHandle.WaitOne();
Log.LogInformation("Exiting...");
rtpSocket?.Close();
controlSocket?.Close();
if (userAgent != null)
{
if (userAgent.IsAnswered)
{
Log.LogInformation($"Hanging up call to {userAgent?.CallDescriptor?.To}.");
userAgent.Hangup();
}
// Give the final request time to be transmitted.
Log.LogInformation("Waiting 1s for call to clean up...");
Task.Delay(1000).Wait();
}
SIPSorcery.Net.DNSManager.Stop();
if (sipTransport != null)
{
Log.LogInformation("Shutting down SIP transport...");
sipTransport.Shutdown();
}
}
static void Main(string[] args)
{
Console.WriteLine("SIPSorcery client user agent example.");
Console.WriteLine("Press ctrl-c to exit.");
// Plumbing code to facilitate a graceful exit.
ManualResetEvent exitMre = new ManualResetEvent(false);
bool isCallHungup = false;
bool hasCallFailed = false;
AddConsoleLogger();
SIPURI callUri = SIPURI.ParseSIPURI(DEFAULT_DESTINATION_SIP_URI);
if (args != null && args.Length > 0)
{
if (!SIPURI.TryParse(args[0], out callUri))
{
Log.LogWarning($"Command line argument could not be parsed as a SIP URI {args[0]}");
}
}
Log.LogInformation($"Call destination {callUri}.");
// Set up a default SIP transport.
var sipTransport = new SIPTransport();
EnableTraceLogs(sipTransport);
// Get the IP address the RTP will be sent from. While we can listen on IPAddress.Any | IPv6Any
// we can't put 0.0.0.0 or [::0] in the SDP or the callee will treat our RTP stream as inactive.
var lookupResult = SIPDNSManager.ResolveSIPService(callUri, false);
Log.LogDebug($"DNS lookup result for {callUri}: {lookupResult?.GetSIPEndPoint()}.");
var dstAddress = lookupResult.GetSIPEndPoint().Address;
var localOfferAddress = NetServices.GetLocalAddressForRemote(dstAddress);
// Initialise an RTP session to receive the RTP packets from the remote SIP server.
var audioOptions = new AudioOptions
{
AudioSource = AudioSourcesEnum.CaptureDevice,
AudioCodecs = new List <SDPMediaFormatsEnum> {
SDPMediaFormatsEnum.PCMA, SDPMediaFormatsEnum.PCMU
},
OutputDeviceIndex = AudioOptions.DEFAULT_OUTPUTDEVICE_INDEX
};
var rtpSession = new RtpAVSession(audioOptions, null);
var offerSDP = rtpSession.CreateOffer(localOfferAddress);
// Create a client user agent to place a call to a remote SIP server along with event handlers for the different stages of the call.
var uac = new SIPClientUserAgent(sipTransport);
uac.CallTrying += (uac, resp) => Log.LogInformation($"{uac.CallDescriptor.To} Trying: {resp.StatusCode} {resp.ReasonPhrase}.");
uac.CallRinging += (uac, resp) =>
{
Log.LogInformation($"{uac.CallDescriptor.To} Ringing: {resp.StatusCode} {resp.ReasonPhrase}.");
if (resp.Status == SIPResponseStatusCodesEnum.SessionProgress)
{
rtpSession.Start();
}
};
uac.CallFailed += (uac, err, resp) =>
{
Log.LogWarning($"{uac.CallDescriptor.To} Failed: {err}");
hasCallFailed = true;
};
uac.CallAnswered += (iuac, resp) =>
{
if (resp.Status == SIPResponseStatusCodesEnum.Ok)
{
Log.LogInformation($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
var result = rtpSession.SetRemoteDescription(SdpType.answer, SDP.ParseSDPDescription(resp.Body));
if (result == SetDescriptionResultEnum.OK)
{
rtpSession.Start();
}
else
{
Log.LogWarning($"Failed to set remote description {result}.");
uac.Hangup();
}
}
else
{
Log.LogWarning($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
}
};
// The only incoming request that needs to be explicitly handled for this example is if the remote end hangs up the call.
sipTransport.SIPTransportRequestReceived += async(SIPEndPoint localSIPEndPoint, SIPEndPoint remoteEndPoint, SIPRequest sipRequest) =>
{
if (sipRequest.Method == SIPMethodsEnum.BYE)
{
SIPResponse okResponse = SIPResponse.GetResponse(sipRequest, SIPResponseStatusCodesEnum.Ok, null);
await sipTransport.SendResponseAsync(okResponse);
if (uac.IsUACAnswered)
{
Log.LogInformation("Call was hungup by remote server.");
isCallHungup = true;
exitMre.Set();
}
}
};
// Start the thread that places the call.
SIPCallDescriptor callDescriptor = new SIPCallDescriptor(
SIPConstants.SIP_DEFAULT_USERNAME,
null,
callUri.ToString(),
SIPConstants.SIP_DEFAULT_FROMURI,
callUri.CanonicalAddress,
null, null, null,
SIPCallDirection.Out,
SDP.SDP_MIME_CONTENTTYPE,
offerSDP.ToString(),
null);
uac.Call(callDescriptor);
uac.ServerTransaction.TransactionTraceMessage += (tx, msg) => Log.LogInformation($"UAC tx trace message. {msg}");
// Ctrl-c will gracefully exit the call at any point.
Console.CancelKeyPress += delegate(object sender, ConsoleCancelEventArgs e)
{
e.Cancel = true;
exitMre.Set();
};
// Wait for a signal saying the call failed, was cancelled with ctrl-c or completed.
exitMre.WaitOne();
Log.LogInformation("Exiting...");
rtpSession.Close(null);
if (!isCallHungup && uac != null)
{
if (uac.IsUACAnswered)
{
Log.LogInformation($"Hanging up call to {uac.CallDescriptor.To}.");
uac.Hangup();
}
else if (!hasCallFailed)
{
Log.LogInformation($"Cancelling call to {uac.CallDescriptor.To}.");
uac.Cancel();
}
// Give the BYE or CANCEL request time to be transmitted.
Log.LogInformation("Waiting 1s for call to clean up...");
Task.Delay(1000).Wait();
}
SIPSorcery.Net.DNSManager.Stop();
if (sipTransport != null)
{
Log.LogInformation("Shutting down SIP transport...");
sipTransport.Shutdown();
}
}
/// <summary>
/// Attempts to create a client TCP socket connection to a remote end point.
/// </summary>
/// <param name="dstEndPoint">The remote TCP end point to attempt to connect to.</param>
/// <param name="buffer">An optional buffer that if set can contain data to transmit immediately after connecting.</param>
/// <returns>If successful a connected client socket or null if not.</returns>
internal async Task <SocketError> ConnectClientAsync(IPEndPoint dstEndPoint, byte[] buffer,
string serverCertificateName)
{
try
{
// No existing TCP connection to the destination. Attempt a new socket connection.
IPAddress localAddress = ListeningIPAddress;
if (ListeningIPAddress == IPAddress.Any)
{
localAddress = NetServices.GetLocalAddressForRemote(dstEndPoint.Address);
}
IPEndPoint localEndPoint = new IPEndPoint(localAddress, Port);
Logger.Logger.Debug(
$"ConnectAsync SIP {ProtDescr} Channel local end point of {localEndPoint} selected for connection to {dstEndPoint}.");
Socket clientSocket = new Socket(dstEndPoint.AddressFamily, SocketType.Stream, ProtocolType.Tcp);
clientSocket.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.ReuseAddress, true);
clientSocket.LingerState = new LingerOption(true, 0);
clientSocket.Bind(localEndPoint);
SocketAsyncEventArgs connectArgs = new SocketAsyncEventArgs
{
RemoteEndPoint = dstEndPoint
};
// NOTE: The approach of setting the buffer on the connect args worked properly on Windows BUT
// not so on Linux. Since it's such a tiny saving skip setting the buffer on the connect and
// do the send once the sockets are connected (use SendOnConnected).
// If this is a TCP channel can take a shortcut and set the first send payload on the connect args.
//if (buffer != null && buffer.Length > 0 && serverCertificateName == null)
//{
// connectArgs.SetBuffer(buffer, 0, buffer.Length);
//}
Logger.Logger.Debug($"Attempting TCP connection from {localEndPoint} to {dstEndPoint}.");
// Attempt to connect.
TaskCompletionSource <SocketError> connectTcs =
new TaskCompletionSource <SocketError>(TaskCreationOptions.RunContinuationsAsynchronously);
connectArgs.Completed += (sender, sockArgs) =>
{
if (sockArgs.LastOperation == SocketAsyncOperation.Connect)
{
connectTcs.SetResult(sockArgs.SocketError);
}
};
bool willRaiseEvent = clientSocket.ConnectAsync(connectArgs);
if (!willRaiseEvent)
{
if (connectArgs.LastOperation == SocketAsyncOperation.Connect)
{
connectTcs.SetResult(connectArgs.SocketError);
}
}
var connectResult = await connectTcs.Task.ConfigureAwait(false);
Logger.Logger.Debug(
$"ConnectAsync SIP {ProtDescr} Channel connect completed result for {localEndPoint}->{dstEndPoint} {connectResult}.");
if (connectResult != SocketError.Success)
{
Logger.Logger.Warn(
$"SIP {ProtDescr} Channel send to {dstEndPoint} failed. Attempt to create a client socket failed.");
}
else
{
SIPStreamConnection sipStmConn = new SIPStreamConnection(clientSocket,
clientSocket.RemoteEndPoint as IPEndPoint, SIPProtocol);
sipStmConn.SIPMessageReceived += SIPTCPMessageReceived;
m_connections.TryAdd(sipStmConn.ConnectionID, sipStmConn);
await OnClientConnect(sipStmConn, serverCertificateName).ConfigureAwait(false);
await SendOnConnected(sipStmConn, buffer).ConfigureAwait(false);
}
return(connectResult);
}
catch (Exception excp)
{
Logger.Logger.Error($"Exception ConnectClientAsync. ->{excp.Message}");
return(SocketError.Fault);
}
}
static void Main()
{
Console.WriteLine("SIPSorcery call hold example.");
Console.WriteLine("Press ctrl-c to exit.");
// Plumbing code to facilitate a graceful exit.
CancellationTokenSource exitCts = new CancellationTokenSource(); // Cancellation token to stop the SIP trnasport and RTP stream.
bool isCallHungup = false;
bool hasCallFailed = false;
AddConsoleLogger();
SIPURI callUri = SIPURI.ParseSIPURI(DEFAULT_DESTINATION_SIP_URI);
Log.LogInformation($"Call destination {callUri}.");
// Set up a default SIP transport.
var sipTransport = new SIPTransport();
sipTransport.AddSIPChannel(new SIPUDPChannel(new IPEndPoint(IPAddress.Any, 0)));
EnableTraceLogs(sipTransport);
var lookupResult = SIPDNSManager.ResolveSIPService(callUri, false);
Log.LogDebug($"DNS lookup result for {callUri}: {lookupResult?.GetSIPEndPoint()}.");
var dstAddress = lookupResult.GetSIPEndPoint().Address;
IPAddress localIPAddress = NetServices.GetLocalAddressForRemote(dstAddress);
// Initialise an RTP session to receive the RTP packets from the remote SIP server.
Socket rtpSocket = null;
Socket controlSocket = null;
NetServices.CreateRtpSocket(localIPAddress, 48000, 48100, false, out rtpSocket, out controlSocket);
var rtpRecvSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
var rtpSendSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
// Create a client user agent to place a call to a remote SIP server along with event handlers for the different stages of the call.
var uac = new SIPClientUserAgent(sipTransport);
uac.CallTrying += (uac, resp) =>
{
Log.LogInformation($"{uac.CallDescriptor.To} Trying: {resp.StatusCode} {resp.ReasonPhrase}.");
};
uac.CallRinging += (uac, resp) => Log.LogInformation($"{uac.CallDescriptor.To} Ringing: {resp.StatusCode} {resp.ReasonPhrase}.");
uac.CallFailed += (uac, err) =>
{
Log.LogWarning($"{uac.CallDescriptor.To} Failed: {err}");
hasCallFailed = true;
};
uac.CallAnswered += (uac, resp) =>
{
if (resp.Status == SIPResponseStatusCodesEnum.Ok)
{
Log.LogInformation($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
// Only set the remote RTP end point if there hasn't already been a packet received on it.
if (_remoteRtpEndPoint == null)
{
_remoteRtpEndPoint = SDP.GetSDPRTPEndPoint(resp.Body);
Log.LogDebug($"Remote RTP socket {_remoteRtpEndPoint}.");
}
}
else
{
Log.LogWarning($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
}
};
// The only incoming request that needs to be explicitly handled for this example is if the remote end hangs up the call.
sipTransport.SIPTransportRequestReceived += (SIPEndPoint localSIPEndPoint, SIPEndPoint remoteEndPoint, SIPRequest sipRequest) =>
{
if (sipRequest.Method == SIPMethodsEnum.BYE)
{
SIPNonInviteTransaction byeTransaction = sipTransport.CreateNonInviteTransaction(sipRequest, null);
SIPResponse byeResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.Ok, null);
byeTransaction.SendFinalResponse(byeResponse);
if (uac.IsUACAnswered)
{
Log.LogInformation("Call was hungup by remote server.");
isCallHungup = true;
exitCts.Cancel();
}
}
};
// It's a good idea to start the RTP receiving socket before the call request is sent.
// A SIP server will generally start sending RTP as soon as it has processed the incoming call request and
// being ready to receive will stop any ICMP error response being generated.
Task.Run(() => RecvRtp(rtpSocket, rtpRecvSession, exitCts));
Task.Run(() => SendRtp(rtpSocket, rtpSendSession, exitCts));
// Start the thread that places the call.
SIPCallDescriptor callDescriptor = new SIPCallDescriptor(
SIP_USERNAME,
SIP_PASSWORD,
callUri.ToString(),
$"sip:{SIP_USERNAME}@localhost",
callUri.CanonicalAddress,
null, null, null,
SIPCallDirection.Out,
SDP.SDP_MIME_CONTENTTYPE,
GetSDP(rtpSocket.LocalEndPoint as IPEndPoint).ToString(),
null);
uac.Call(callDescriptor);
// Ctrl-c will gracefully exit the call at any point.
Console.CancelKeyPress += delegate(object sender, ConsoleCancelEventArgs e)
{
e.Cancel = true;
exitCts.Cancel();
};
// At this point the call has been initiated and everything will be handled in an event handler.
Task.Run(() =>
{
try
{
while (!exitCts.Token.WaitHandle.WaitOne(0))
{
var keyProps = Console.ReadKey();
if (keyProps.KeyChar == 'h')
{
}
else if (keyProps.KeyChar == 'q')
{
Console.WriteLine();
Console.WriteLine("Hangup requested by user...");
uac.Hangup();
exitCts.Cancel();
rtpSocket?.Close();
controlSocket?.Close();
SIPSorcery.Sys.Log.Logger.LogInformation("Quitting...");
if (sipTransport != null)
{
SIPSorcery.Sys.Log.Logger.LogInformation("Shutting down SIP transport...");
sipTransport.Shutdown();
}
}
}
}
catch (Exception excp)
{
SIPSorcery.Sys.Log.Logger.LogError($"Exception Key Press listener. {excp.Message}.");
}
});
// Wait for a signal saying the call failed, was cancelled with ctrl-c or completed.
exitCts.Token.WaitHandle.WaitOne();
Log.LogInformation("Exiting...");
rtpSocket?.Close();
controlSocket?.Close();
if (!isCallHungup && uac != null)
{
if (uac.IsUACAnswered)
{
Log.LogInformation($"Hanging up call to {uac.CallDescriptor.To}.");
uac.Hangup();
}
else if (!hasCallFailed)
{
Log.LogInformation($"Cancelling call to {uac.CallDescriptor.To}.");
uac.Cancel();
}
// Give the BYE or CANCEL request time to be transmitted.
Log.LogInformation("Waiting 1s for call to clean up...");
Task.Delay(1000).Wait();
}
SIPSorcery.Net.DNSManager.Stop();
if (sipTransport != null)
{
Log.LogInformation("Shutting down SIP transport...");
sipTransport.Shutdown();
}
}
private static int INPUT_SAMPLE_PERIOD_MILLISECONDS = 20; // This sets the frequency of the RTP packets.
static void Main(string[] args)
{
Console.WriteLine("SIPSorcery client user agent example.");
Console.WriteLine("Press ctrl-c to exit.");
// Plumbing code to facilitate a graceful exit.
ManualResetEvent exitMre = new ManualResetEvent(false);
bool isCallHungup = false;
bool hasCallFailed = false;
AddConsoleLogger();
SIPURI callUri = SIPURI.ParseSIPURI(DEFAULT_DESTINATION_SIP_URI);
if (args != null && args.Length > 0)
{
if (!SIPURI.TryParse(args[0], out callUri))
{
Log.LogWarning($"Command line argument could not be parsed as a SIP URI {args[0]}");
}
}
Log.LogInformation($"Call destination {callUri}.");
// Set up a default SIP transport.
var sipTransport = new SIPTransport();
EnableTraceLogs(sipTransport);
// Get the IP address the RTP will be sent from. While we can listen on IPAddress.Any | IPv6Any
// we can't put 0.0.0.0 or [::0] in the SDP or the callee will ignore us.
var lookupResult = SIPDNSManager.ResolveSIPService(callUri, false);
Log.LogDebug($"DNS lookup result for {callUri}: {lookupResult?.GetSIPEndPoint()}.");
var dstAddress = lookupResult.GetSIPEndPoint().Address;
IPAddress localIPAddress = NetServices.GetLocalAddressForRemote(dstAddress);
// Initialise an RTP session to receive the RTP packets from the remote SIP server.
var rtpSession = new RTPMediaSession((int)SDPMediaFormatsEnum.PCMU, localIPAddress.AddressFamily);
var offerSDP = rtpSession.GetSDP(localIPAddress);
// Get the audio input device.
WaveInEvent waveInEvent = GetAudioInputDevice();
// Create a client user agent to place a call to a remote SIP server along with event handlers for the different stages of the call.
var uac = new SIPClientUserAgent(sipTransport);
uac.CallTrying += (uac, resp) => Log.LogInformation($"{uac.CallDescriptor.To} Trying: {resp.StatusCode} {resp.ReasonPhrase}.");
uac.CallRinging += (uac, resp) => Log.LogInformation($"{uac.CallDescriptor.To} Ringing: {resp.StatusCode} {resp.ReasonPhrase}.");
uac.CallFailed += (uac, err) =>
{
Log.LogWarning($"{uac.CallDescriptor.To} Failed: {err}");
hasCallFailed = true;
};
uac.CallAnswered += (uac, resp) =>
{
if (resp.Status == SIPResponseStatusCodesEnum.Ok)
{
Log.LogInformation($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
// Only set the remote RTP end point if there hasn't already been a packet received on it.
if (rtpSession.DestinationEndPoint == null)
{
rtpSession.DestinationEndPoint = SDP.GetSDPRTPEndPoint(resp.Body);
Log.LogDebug($"Remote RTP socket {rtpSession.DestinationEndPoint}.");
}
rtpSession.SetRemoteSDP(SDP.ParseSDPDescription(resp.Body));
waveInEvent.StartRecording();
}
else
{
Log.LogWarning($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
}
};
// The only incoming request that needs to be explicitly handled for this example is if the remote end hangs up the call.
sipTransport.SIPTransportRequestReceived += async(SIPEndPoint localSIPEndPoint, SIPEndPoint remoteEndPoint, SIPRequest sipRequest) =>
{
if (sipRequest.Method == SIPMethodsEnum.BYE)
{
SIPResponse okResponse = SIPResponse.GetResponse(sipRequest, SIPResponseStatusCodesEnum.Ok, null);
await sipTransport.SendResponseAsync(okResponse);
if (uac.IsUACAnswered)
{
Log.LogInformation("Call was hungup by remote server.");
isCallHungup = true;
exitMre.Set();
}
}
};
// Wire up the RTP receive session to the audio output device.
var(audioOutEvent, audioOutProvider) = GetAudioOutputDevice();
rtpSession.OnReceivedSampleReady += (sample) =>
{
for (int index = 0; index < sample.Length; index++)
{
short pcm = NAudio.Codecs.MuLawDecoder.MuLawToLinearSample(sample[index]);
byte[] pcmSample = new byte[] { (byte)(pcm & 0xFF), (byte)(pcm >> 8) };
audioOutProvider.AddSamples(pcmSample, 0, 2);
}
};
// Wire up the RTP send session to the audio input device.
uint rtpSendTimestamp = 0;
waveInEvent.DataAvailable += (object sender, WaveInEventArgs args) =>
{
byte[] sample = new byte[args.Buffer.Length / 2];
int sampleIndex = 0;
for (int index = 0; index < args.BytesRecorded; index += 2)
{
var ulawByte = NAudio.Codecs.MuLawEncoder.LinearToMuLawSample(BitConverter.ToInt16(args.Buffer, index));
sample[sampleIndex++] = ulawByte;
}
if (rtpSession.DestinationEndPoint != null)
{
rtpSession.SendAudioFrame(rtpSendTimestamp, sample);
rtpSendTimestamp += (uint)(8000 / waveInEvent.BufferMilliseconds);
}
};
// Start the thread that places the call.
SIPCallDescriptor callDescriptor = new SIPCallDescriptor(
SIPConstants.SIP_DEFAULT_USERNAME,
null,
callUri.ToString(),
SIPConstants.SIP_DEFAULT_FROMURI,
callUri.CanonicalAddress,
null, null, null,
SIPCallDirection.Out,
SDP.SDP_MIME_CONTENTTYPE,
offerSDP.ToString(),
null);
uac.Call(callDescriptor);
uac.ServerTransaction.TransactionTraceMessage += (tx, msg) => Log.LogInformation($"UAC tx trace message. {msg}");
// Ctrl-c will gracefully exit the call at any point.
Console.CancelKeyPress += delegate(object sender, ConsoleCancelEventArgs e)
{
e.Cancel = true;
exitMre.Set();
};
// Wait for a signal saying the call failed, was cancelled with ctrl-c or completed.
exitMre.WaitOne();
Log.LogInformation("Exiting...");
waveInEvent?.StopRecording();
audioOutEvent?.Stop();
rtpSession.CloseSession(null);
if (!isCallHungup && uac != null)
{
if (uac.IsUACAnswered)
{
Log.LogInformation($"Hanging up call to {uac.CallDescriptor.To}.");
uac.Hangup();
}
else if (!hasCallFailed)
{
Log.LogInformation($"Cancelling call to {uac.CallDescriptor.To}.");
uac.Cancel();
}
// Give the BYE or CANCEL request time to be transmitted.
Log.LogInformation("Waiting 1s for call to clean up...");
Task.Delay(1000).Wait();
}
SIPSorcery.Net.DNSManager.Stop();
if (sipTransport != null)
{
Log.LogInformation("Shutting down SIP transport...");
sipTransport.Shutdown();
}
}
/// <summary>
/// Answers the call request contained in the user agent server parameter. Note the
/// <see cref="AcceptCall(SIPRequest)"/> method should be used to create the user agent server.
/// Any existing call will be hungup.
/// </summary>
/// <param name="uas">The user agent server holding the pending call to answer.</param>
/// <param name="mediaSession">The media session used for this call</param>
/// <param name="customHeaders">Custom SIP-Headers to use in Answer.</param>
/// <returns>True if the call was successfully answered or false if there was a problem
/// such as incompatible codecs.</returns>
public async Task <bool> Answer(SIPServerUserAgent uas, IMediaSession mediaSession, string[] customHeaders)
{
// This call is now taking over any existing call.
if (IsCallActive)
{
Hangup();
}
if (uas.IsCancelled)
{
logger.LogDebug("The incoming call has been cancelled.");
mediaSession?.Close("call cancelled");
return(false);
}
else
{
m_cts = new CancellationTokenSource();
var sipRequest = uas.ClientTransaction.TransactionRequest;
MediaSession = mediaSession;
MediaSession.OnRtpEvent += OnRemoteRtpEvent;
MediaSession.OnRtpClosed += (reason) =>
{
if (!MediaSession.IsClosed)
{
logger.LogWarning($"RTP channel was closed with reason {reason}.");
}
};
string sdp = null;
if (!String.IsNullOrEmpty(sipRequest.Body))
{
// The SDP offer was included in the INVITE request.
SDP remoteSdp = SDP.ParseSDPDescription(sipRequest.Body);
var setRemoteResult = MediaSession.SetRemoteDescription(remoteSdp);
if (setRemoteResult != SetDescriptionResultEnum.OK)
{
logger.LogWarning($"Error setting remote description from INVITE {setRemoteResult}.");
uas.Reject(SIPResponseStatusCodesEnum.NotAcceptable, setRemoteResult.ToString());
MediaSession.Close("sdp offer not acceptable");
Hangup();
return(false);
}
else
{
var sdpAnswer = MediaSession.CreateAnswer(null);
sdp = sdpAnswer.ToString();
}
}
else
{
// No SDP offer was included in the INVITE request need to wait for the ACK.
var sdpAnnounceAddress = NetServices.GetLocalAddressForRemote(sipRequest.RemoteSIPEndPoint.GetIPEndPoint().Address);
var sdpOffer = MediaSession.CreateOffer(sdpAnnounceAddress);
sdp = sdpOffer.ToString();
}
m_uas = uas;
// In cases where the initial INVITE did not contain an SDP offer the action sequence is:
// - INVITE with no SDP offer received,
// - Reply with OK and an SDP offer,
// - Wait for ACK with SDP answer.
TaskCompletionSource <SIPDialogue> dialogueCreatedTcs = new TaskCompletionSource <SIPDialogue>(TaskCreationOptions.RunContinuationsAsynchronously);
m_uas.OnDialogueCreated += (dialogue) => dialogueCreatedTcs.TrySetResult(dialogue);
m_uas.Answer(m_sdpContentType, sdp, null, SIPDialogueTransferModesEnum.Default, customHeaders);
await Task.WhenAny(dialogueCreatedTcs.Task, Task.Delay(WAIT_DIALOG_TIMEOUT)).ConfigureAwait(false);
if (Dialogue != null)
{
if (MediaSession.RemoteDescription == null)
{
// If the initial INVITE did not contain an offer then the remote description will not yet be set.
var remoteSDP = SDP.ParseSDPDescription(Dialogue.RemoteSDP);
var setRemoteResult = MediaSession.SetRemoteDescription(remoteSDP);
if (setRemoteResult != SetDescriptionResultEnum.OK)
{
// Failed to set the remote SDP from the ACK request. Only option is to hangup.
logger.LogWarning($"Error setting remote description from ACK {setRemoteResult}.");
MediaSession.Close(setRemoteResult.ToString());
Hangup();
return(false);
}
else
{
// SDP from the ACK request was accepted. Start the RTP session.
Dialogue.DialogueState = SIPDialogueStateEnum.Confirmed;
await MediaSession.Start().ConfigureAwait(false);
return(true);
}
}
else
{
Dialogue.DialogueState = SIPDialogueStateEnum.Confirmed;
await MediaSession.Start().ConfigureAwait(false);
return(true);
}
}
else
{
logger.LogWarning("The attempt to answer a call failed as the dialog was not created. The likely cause is the ACK not being received in time.");
MediaSession.Close("dialog creation failed");
Hangup();
return(false);
}
}
}
private static ConcurrentQueue <RTPEvent> _dtmfEvents = new ConcurrentQueue <RTPEvent>(); // Add a DTMF event to this queue to have the it sent
static void Main()
{
Console.WriteLine("SIPSorcery client user agent example.");
Console.WriteLine("Press ctrl-c to exit.");
// Plumbing code to facilitate a graceful exit.
CancellationTokenSource rtpCts = new CancellationTokenSource(); // Cancellation token to stop the RTP stream.
bool isCallHungup = false;
bool hasCallFailed = false;
AddConsoleLogger();
SIPURI callUri = SIPURI.ParseSIPURI(DEFAULT_DESTINATION_SIP_URI);
Log.LogInformation($"Call destination {callUri}.");
// Set up a default SIP transport.
var sipTransport = new SIPTransport();
sipTransport.AddSIPChannel(new SIPUDPChannel(new IPEndPoint(IPAddress.Any, 0)));
// Un/comment this line to see/hide each SIP message sent and received.
EnableTraceLogs(sipTransport);
// Note this relies on the callURI host being an IP address. If it's a hostname a DNS lookup is required.
IPAddress localIPAddress = NetServices.GetLocalAddressForRemote(callUri.ToSIPEndPoint().Address);
// Initialise an RTP session to receive the RTP packets from the remote SIP server.
Socket rtpSocket = null;
Socket controlSocket = null;
NetServices.CreateRtpSocket(localIPAddress, 49000, 49100, false, out rtpSocket, out controlSocket);
var rtpRecvSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
var rtpSendSession = new RTPSession((int)RTPPayloadTypesEnum.PCMU, null, null);
// Create a client user agent to place a call to a remote SIP server along with event handlers for the different stages of the call.
var uac = new SIPClientUserAgent(sipTransport);
uac.CallTrying += (uac, resp) =>
{
Log.LogInformation($"{uac.CallDescriptor.To} Trying: {resp.StatusCode} {resp.ReasonPhrase}.");
};
uac.CallRinging += (uac, resp) => Log.LogInformation($"{uac.CallDescriptor.To} Ringing: {resp.StatusCode} {resp.ReasonPhrase}.");
uac.CallFailed += (uac, err) =>
{
Log.LogWarning($"{uac.CallDescriptor.To} Failed: {err}");
hasCallFailed = true;
};
uac.CallAnswered += (uac, resp) =>
{
if (resp.Status == SIPResponseStatusCodesEnum.Ok)
{
Log.LogInformation($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
_remoteRtpEndPoint = SDP.GetSDPRTPEndPoint(resp.Body);
Log.LogDebug($"Remote RTP socket {_remoteRtpEndPoint}.");
}
else
{
Log.LogWarning($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
}
};
// The only incoming request that needs to be explicitly handled for this example is if the remote end hangs up the call.
sipTransport.SIPTransportRequestReceived += (SIPEndPoint localSIPEndPoint, SIPEndPoint remoteEndPoint, SIPRequest sipRequest) =>
{
if (sipRequest.Method == SIPMethodsEnum.BYE)
{
SIPNonInviteTransaction byeTransaction = sipTransport.CreateNonInviteTransaction(sipRequest, null);
SIPResponse byeResponse = SIPTransport.GetResponse(sipRequest, SIPResponseStatusCodesEnum.Ok, null);
byeTransaction.SendFinalResponse(byeResponse);
if (uac.IsUACAnswered)
{
Log.LogInformation("Call was hungup by remote server.");
isCallHungup = true;
rtpCts.Cancel();
}
}
};
// It's a good idea to start the RTP receiving socket before the call request is sent.
// A SIP server will generally start sending RTP as soon as it has processed the incoming call request and
// being ready to receive will stop any ICMP error response being generated.
Task.Run(() => RecvRtp(rtpSocket, rtpRecvSession, rtpCts));
Task.Run(() => SendRtp(rtpSocket, rtpSendSession, rtpCts));
// Start the thread that places the call.
SIPCallDescriptor callDescriptor = new SIPCallDescriptor(
SIPConstants.SIP_DEFAULT_USERNAME,
null,
callUri.ToString(),
SIPConstants.SIP_DEFAULT_FROMURI,
null, null, null, null,
SIPCallDirection.Out,
SDP.SDP_MIME_CONTENTTYPE,
GetSDP(rtpSocket.LocalEndPoint as IPEndPoint, RTPPayloadTypesEnum.PCMU).ToString(),
null);
uac.Call(callDescriptor);
// Ctrl-c will gracefully exit the call at any point.
Console.CancelKeyPress += delegate(object sender, ConsoleCancelEventArgs e)
{
e.Cancel = true;
rtpCts.Cancel();
};
// At this point the call has been initiated and everything will be handled in an event handler or on the RTP
// receive task. The code below is to gracefully exit.
Task.Delay(3000).Wait();
// Add some DTMF events to the queue. These will be transmitted by the SendRtp thread.
_dtmfEvents.Enqueue(new RTPEvent(0x05, false, RTPEvent.DEFAULT_VOLUME, 1200, DTMF_EVENT_PAYLOAD_ID));
Task.Delay(2000, rtpCts.Token).Wait();
_dtmfEvents.Enqueue(new RTPEvent(0x09, false, RTPEvent.DEFAULT_VOLUME, 1200, DTMF_EVENT_PAYLOAD_ID));
Task.Delay(2000, rtpCts.Token).Wait();
_dtmfEvents.Enqueue(new RTPEvent(0x02, false, RTPEvent.DEFAULT_VOLUME, 1200, DTMF_EVENT_PAYLOAD_ID));
Task.Delay(2000, rtpCts.Token).Wait();
Log.LogInformation("Exiting...");
rtpCts.Cancel();
rtpSocket?.Close();
controlSocket?.Close();
if (!isCallHungup && uac != null)
{
if (uac.IsUACAnswered)
{
Log.LogInformation($"Hanging up call to {uac.CallDescriptor.To}.");
uac.Hangup();
}
else if (!hasCallFailed)
{
Log.LogInformation($"Cancelling call to {uac.CallDescriptor.To}.");
uac.Cancel();
}
// Give the BYE or CANCEL request time to be transmitted.
Log.LogInformation("Waiting 1s for call to clean up...");
Task.Delay(1000).Wait();
}
SIPSorcery.Net.DNSManager.Stop();
if (sipTransport != null)
{
Log.LogInformation("Shutting down SIP transport...");
sipTransport.Shutdown();
}
}
static void Main()
{
Console.WriteLine("SIPSorcery client user agent example.");
Console.WriteLine("Press ctrl-c to exit.");
// Plumbing code to facilitate a graceful exit.
CancellationTokenSource rtpCts = new CancellationTokenSource(); // Cancellation token to stop the RTP stream.
bool isCallHungup = false;
bool hasCallFailed = false;
AddConsoleLogger();
SIPURI callUri = SIPURI.ParseSIPURI(DEFAULT_DESTINATION_SIP_URI);
Log.LogInformation($"Call destination {callUri}.");
// Set up a default SIP transport.
var sipTransport = new SIPTransport();
sipTransport.AddSIPChannel(new SIPUDPChannel(new IPEndPoint(IPAddress.Any, 0)));
// Un/comment this line to see/hide each SIP message sent and received.
EnableTraceLogs(sipTransport);
// Note this relies on the callURI host being an IP address. If it's a hostname a DNS lookup is required.
IPAddress localIPAddress = NetServices.GetLocalAddressForRemote(callUri.ToSIPEndPoint().Address);
// Initialise an RTP session to receive the RTP packets from the remote SIP server.
var rtpSession = new RTPMediaSession((int)SDPMediaFormatsEnum.PCMU, localIPAddress.AddressFamily);
var offerSDP = rtpSession.GetSDP(localIPAddress);
// Create a client user agent to place a call to a remote SIP server along with event handlers for the different stages of the call.
var uac = new SIPClientUserAgent(sipTransport);
uac.CallTrying += (uac, resp) =>
{
Log.LogInformation($"{uac.CallDescriptor.To} Trying: {resp.StatusCode} {resp.ReasonPhrase}.");
};
uac.CallRinging += (uac, resp) => Log.LogInformation($"{uac.CallDescriptor.To} Ringing: {resp.StatusCode} {resp.ReasonPhrase}.");
uac.CallFailed += (uac, err) =>
{
Log.LogWarning($"{uac.CallDescriptor.To} Failed: {err}");
hasCallFailed = true;
};
uac.CallAnswered += (uac, resp) =>
{
if (resp.Status == SIPResponseStatusCodesEnum.Ok)
{
Log.LogInformation($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
rtpSession.DestinationEndPoint = SDP.GetSDPRTPEndPoint(resp.Body);
Log.LogDebug($"Remote RTP socket {rtpSession.DestinationEndPoint}.");
}
else
{
Log.LogWarning($"{uac.CallDescriptor.To} Answered: {resp.StatusCode} {resp.ReasonPhrase}.");
}
};
// The only incoming request that needs to be explicitly handled for this example is if the remote end hangs up the call.
sipTransport.SIPTransportRequestReceived += async(SIPEndPoint localSIPEndPoint, SIPEndPoint remoteEndPoint, SIPRequest sipRequest) =>
{
if (sipRequest.Method == SIPMethodsEnum.BYE)
{
SIPResponse okResponse = SIPResponse.GetResponse(sipRequest, SIPResponseStatusCodesEnum.Ok, null);
await sipTransport.SendResponseAsync(okResponse);
if (uac.IsUACAnswered)
{
Log.LogInformation("Call was hungup by remote server.");
isCallHungup = true;
rtpCts.Cancel();
}
}
};
// Wire up the RTP receive session to the default speaker.
var(audioOutEvent, audioOutProvider) = GetAudioOutputDevice();
rtpSession.OnReceivedSampleReady += (sample) =>
{
for (int index = 0; index < sample.Length; index++)
{
short pcm = NAudio.Codecs.MuLawDecoder.MuLawToLinearSample(sample[index]);
byte[] pcmSample = new byte[] { (byte)(pcm & 0xFF), (byte)(pcm >> 8) };
audioOutProvider.AddSamples(pcmSample, 0, 2);
}
};
// Send audio packets (in this case silence) to the callee.
Task.Run(() => SendSilence(rtpSession, rtpCts));
// Start the thread that places the call.
SIPCallDescriptor callDescriptor = new SIPCallDescriptor(
SIPConstants.SIP_DEFAULT_USERNAME,
null,
callUri.ToString(),
SIPConstants.SIP_DEFAULT_FROMURI,
null, null, null, null,
SIPCallDirection.Out,
SDP.SDP_MIME_CONTENTTYPE,
offerSDP.ToString(),
null);
uac.Call(callDescriptor);
// Ctrl-c will gracefully exit the call at any point.
Console.CancelKeyPress += delegate(object sender, ConsoleCancelEventArgs e)
{
e.Cancel = true;
rtpCts.Cancel();
};
// Give the call some time to answer.
Task.Delay(3000).Wait();
// Send some DTMF key presses via RTP events.
var dtmf5 = new RTPEvent(0x05, false, RTPEvent.DEFAULT_VOLUME, 1200, RTPMediaSession.DTMF_EVENT_PAYLOAD_ID);
rtpSession.SendDtmfEvent(dtmf5, rtpCts.Token).Wait();
Task.Delay(2000, rtpCts.Token).Wait();
var dtmf9 = new RTPEvent(0x09, false, RTPEvent.DEFAULT_VOLUME, 1200, RTPMediaSession.DTMF_EVENT_PAYLOAD_ID);
rtpSession.SendDtmfEvent(dtmf9, rtpCts.Token).Wait();
Task.Delay(2000, rtpCts.Token).Wait();
var dtmf2 = new RTPEvent(0x02, false, RTPEvent.DEFAULT_VOLUME, 1200, RTPMediaSession.DTMF_EVENT_PAYLOAD_ID);
rtpSession.SendDtmfEvent(dtmf2, rtpCts.Token).Wait();
Task.Delay(2000, rtpCts.Token).ContinueWith((task) => { }).Wait(); // Don't care about the exception if the cancellation token is set.
Log.LogInformation("Exiting...");
rtpCts.Cancel();
audioOutEvent?.Stop();
rtpSession.CloseSession(null);
if (!isCallHungup && uac != null)
{
if (uac.IsUACAnswered)
{
Log.LogInformation($"Hanging up call to {uac.CallDescriptor.To}.");
uac.Hangup();
}
else if (!hasCallFailed)
{
Log.LogInformation($"Cancelling call to {uac.CallDescriptor.To}.");
uac.Cancel();
}
// Give the BYE or CANCEL request time to be transmitted.
Log.LogInformation("Waiting 1s for call to clean up...");
Task.Delay(1000).Wait();
}
SIPSorcery.Net.DNSManager.Stop();
if (sipTransport != null)
{
Log.LogInformation("Shutting down SIP transport...");
sipTransport.Shutdown();
}
}