Skip to content

Latest commit

 

History

History
73 lines (57 loc) · 2.95 KB

README.mdown

File metadata and controls

73 lines (57 loc) · 2.95 KB
Raw

This is version 0.85 of MKNetworkKit. Read the blog post for more. The master branch is a live working branch that is not stable yet (especially for Mac).

Till then, pickup the latest stable code at the tag v0.8a

###Licensing

MKNetworkKit is licensed under MIT License Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

###Why MKNetworkKit?

MKNetworkKit is inspired by the other two popular network frameworks ASIHTTPRequest and AFNetworking. Mostly ASI, to some extent, AFNetworking. I've been an unofficial "evangelist" of ASIHTTPRequest till the plug was pulled.

Marrying the feature set from both, MKNetworkKit throws in a bunch of new features like

  • Single queue for the whole app
  • Auto queue sizing
  • Auto caching and restoring
  • Performs exactly one operation for similar requests
  • Background completion
  • Full ARC support
  • cURL-able debug lines.

###How to use Read the blog post for more.

Documentation

Install appledoc from gentlebytes github repo run this on the command line /usr/local/bin/appledoc --project-name MKNetworkKit -v 0.8 --project-company Steinlogic --company-id com.steinlogic.mknetworkkit -o ./Documentation -i .m -s ./MKNetworkKit .

###TODO

  • Method to freeze blocks (alternative techniques probably)
  • UserAgent String (Don't advertise MKNetworkKit, this should be app name)
  • Multiple encoding types in URL
  • Read about response redirects and implement delegate callbacks or use state variables
  • Obey cache-expires HTTP headers
  • Example code for Mac
  • Cache strategy for Mac
  • Fix AppleDoc warnings

I'll be working on this soon. But you can start forking it and getting it right

###Known Issues

  • Frozen operations don't report progress/completion handlers back to the calling code.

###A note on licensing Attribution free licensing available upon request. Contact me at [email protected]