This Fork

This fork adds HTTP-proxy support for APNS binary API.

A user of the library can specify an HTTP-Proxy to tunnel all requests to and responses from APNS by calling SetProxy on ApnsConfiguration before creating the PushBroker

ApnsConfiguration configuration = new ApnsConfiguration(ApnsConfiguration.ApnsServerEnvironment.Production, certificatePath, certPwd, false);
configuration.SetProxy("yourProxyIP", 3128);
pushBroker = new ApnsServiceBroker(configuration);

You may also specify a username, password and domain to authenticate against the Proxy. If nothing is specified, the Default Network Credentials will be used:

configuration.SetProxy("yourProxyIP", 3128, "proxyUser", "proxyPassword", "MY_DOMAIN");

A method to tunnel the TCP-connection via a pre-configured HTTP-Proxy has been added. If Configuration.SetProxy has been called, a CONNECT-request is sent using the proxy adress specified. The socket is then extracted from the stream of this request's response (using the System.Reflection-Library) and used to create a TcpClient-object. All traffic sent through this TcpClient-object will pass through the proxy used to send the initial CONNECT-Request.

Important notice

The APNS Binary API has been declared obsolete and is being discontinued by apple in Favor of the HTTP/2 REST-API. Binary API will not be supported after March 31st 2021! More info: https://developer.apple.com/news/?id=c88acm2b

PushSharp v3.0

PushSharp is a server-side library for sending Push Notifications to iOS/OSX (APNS), Android/Chrome (GCM), Windows/Windows Phone, Amazon (ADM) and Blackberry devices!

PushSharp v3.0 is a complete rewrite of the original library, aimed at taking advantage of things like async/await, HttpClient, and generally a better infrastructure using lessons learned from the old code.

• Read more on my blog http://redth.codes/pushsharp-3-0-the-push-awakens/
• Join the Gitter.im channel with questions/feedback

---

Sample Usage

The API in v3.x series is quite different from 2.x. The goal is to simplify things and focus on the core functionality of the library, leaving things like constructing valid payloads up to the developer.

APNS Sample Usage

Here is an example of how you would send an APNS notification:

// Configurationvarconfig=newApnsConfiguration("push-cert.pfx","push-cert-pwd");// Create a new brokervarbroker=newApnsServiceBroker(config);// Wire up eventsbroker.OnNotificationFailed+=(notification,aggregateEx)=>{aggregateEx.Handle(ex =>{// See what kind of exception it was to further diagnoseif(exisApnsNotificationException){varnotificationException=exasApnsNotificationException;// Deal with the failed notificationvarapnsNotification=notificationException.Notification;varstatusCode=notificationException.ErrorStatusCode;Console.WriteLine($"Notification Failed: ID={apnsNotification.Identifier}, Code={statusCode}");}else{// Inner exception might hold more useful information like an ApnsConnectionException Console.WriteLine($"Notification Failed for some (Unknown Reason) : {ex.InnerException}");}// Mark it as handledreturntrue;});};broker.OnNotificationSucceeded+=(notification)=>{Console.WriteLine("Notification Sent!");};// Start the brokerbroker.Start();foreach(vardeviceTokeninMY_DEVICE_TOKENS){// Queue a notification to sendbroker.QueueNotification(newApnsNotification{DeviceToken=deviceToken,Payload=JObject.Parse("{\"aps\":{\"badge\":7}}")});}// Stop the broker, wait for it to finish // This isn't done after every message, but after you're// done with the brokerbroker.Stop();

Apple APNS Feedback Service

For APNS you will also need to occasionally check with the feedback service to see if there are any expired device tokens you should no longer send notifications to. Here's an example of how you would do that:

varconfig=newApnsConfiguration(ApnsConfiguration.ApnsServerEnvironment.Sandbox,Settings.Instance.ApnsCertificateFile,Settings.Instance.ApnsCertificatePassword);varfbs=newFeedbackService(config);fbs.FeedbackReceived+=(stringdeviceToken,DateTimetimestamp)=>{// Remove the deviceToken from your database// timestamp is the time the token was reported as expired};fbs.Check();

GCM Sample Usage

Here is how you would send a GCM Notification:

// Configurationvarconfig=newGcmConfiguration("GCM-SENDER-ID","AUTH-TOKEN",null);// Create a new brokervarbroker=newGcmServiceBroker(config);// Wire up eventsbroker.OnNotificationFailed+=(notification,aggregateEx)=>{aggregateEx.Handle(ex =>{// See what kind of exception it was to further diagnoseif(exisGcmNotificationException){varnotificationException=exasGcmNotificationException;// Deal with the failed notificationvargcmNotification=notificationException.Notification;vardescription=notificationException.Description;Console.WriteLine($"Notification Failed: ID={gcmNotification.MessageId}, Desc={description}");}elseif(exisGcmMulticastResultException){multicastException=exasGcmMulticastResultException;foreach(varsucceededNotificationinmulticastException.Succeeded){Console.WriteLine($"Notification Failed: ID={succeededNotification.MessageId}");}foreach(varfailedKvpinmulticastException.Failed){varn=failedKvp.Key;vare=failedKvp.Value;Console.WriteLine($"Notification Failed: ID={n.MessageId}, Desc={e.Description}");}}elseif(exisDeviceSubscriptionExpiredException){varoldId=ex.OldSubscriptionId;varnewId=ex.NewSubscriptionId;Console.WriteLine($"Device RegistrationId Expired: {oldId}");if(!string.IsNullOrEmpty(newId)){// If this value isn't null, our subscription changed and we should update our databaseConsole.WriteLine($"Device RegistrationId Changed To: {newId}");}}elseif(exisRetryAfterException){// If you get rate limited, you should stop sending messages until after the RetryAfterUtc dateConsole.WriteLine($"Rate Limited, don't send more until after {ex.RetryAfterUtc}");}else{Console.WriteLine("Notification Failed for some (Unknown Reason)");}// Mark it as handledreturntrue;});};broker.OnNotificationSucceeded+=(notification)=>{Console.WriteLine("Notification Sent!");};// Start the brokerbroker.Start();foreach(varregIdinMY_REGISTRATION_IDS){// Queue a notification to sendbroker.QueueNotification(newGcmNotification{RegistrationIds=newList<string>{regId},Data=JObject.Parse("{ \"somekey\" : \"somevalue\" }")});}// Stop the broker, wait for it to finish // This isn't done after every message, but after you're// done with the brokerbroker.Stop();

WNS Sample Usage

Here's how to send WNS Notifications:

// Configurationvarconfig=newWnsConfiguration("WNS_PACKAGE_NAME","WNS_PACKAGE_SID","WNS_CLIENT_SECRET");// Create a new brokervarbroker=newGcmServiceBroker(config);// Wire up eventsbroker.OnNotificationFailed+=(notification,aggregateEx)=>{aggregateEx.Handle(ex =>{// See what kind of exception it was to further diagnoseif(exisWnsNotificationException){varnotificationException=exasWnsNotificationException;// Deal with the failed notificationvarwnsNotification=notificationException.Notification;varstatus=notificationException.Status;Console.WriteLine($"Notification Failed: ID={wnsNotification.ChannelUri}, Status={status}");}elseif(exisDeviceSubscriptionExpiredException){varoldId=ex.OldSubscriptionId;varnewId=ex.NewSubscriptionId;Console.WriteLine($"Device RegistrationId Expired: {oldId}");if(!string.IsNullOrEmpty(newId)){// If this value isn't null, our subscription changed and we should update our databaseConsole.WriteLine($"Device RegistrationId Changed To: {newId}");}}elseif(exisRetryAfterException){// If you get rate limited, you should stop sending messages until after the RetryAfterUtc dateConsole.WriteLine($"Rate Limited, don't send more until after {ex.RetryAfterUtc}");}else{Console.WriteLine("Notification Failed for some (Unknown Reason)");}// Mark it as handledreturntrue;});};broker.OnNotificationSucceeded+=(notification)=>{Console.WriteLine("Notification Sent!");};// Start the brokerbroker.Start();foreach(varuriinMY_DEVICE_CHANNEL_URIS){// Queue a notification to sendbroker.QueueNotification(newWnsToastNotification{ChannelUri=uri,Payload=XElement.Parse(@" <toast> <visual> <binding template=""ToastText01""> <text id=""1"">WNS_Send_Single</text> </binding>  </visual> </toast>")});}// Stop the broker, wait for it to finish // This isn't done after every message, but after you're// done with the brokerbroker.Stop();

How to Migrate from PushSharp 2.x to 3.x

Please see this Wiki page for more information: https://github.com/Redth/PushSharp/wiki/Migrating-from-PushSharp-2.x-to-3.x

Roadmap

• APNS - Apple Push Notification Service
  • Finish HTTP/2 support (currently in another branch)
• GCM - Google Cloud Messaging
  • XMPP transport still under development
• Other
  • More NUnit tests to be written, with a test GCM Server, and eventually Test servers for other platforms
  • New Xamarin Client samples (how to setup each platform as a push client) will be built and live in a separate repository to be less confusing

License

Copyright 2012-2016 Jonathan Dick

Licensed 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.