dnssd 1.0 → 1.1.0

data/.autotest

@@ -0,0 +1,15 @@
+require 'autotest/restart'
+
+Autotest.add_hook :initialize do |at|
+  at.testlib = 'minitest/unit'
+
+  def at.path_to_classname(s)
+    sep = File::SEPARATOR
+    f = s.sub(/^test#{sep}/, '').sub(/\.rb$/, '').split(sep)
+    f = f.map { |path| path.split(/_|(\d+)/).map { |seg| seg.capitalize }.join }
+    f = f.map { |path| path =~ /^Test/ ? path : "Test#{path}"  }
+    f.join('::').sub 'Dnssd', 'DNSSD'
+  end
+
+end
+

data/History.txt

@@ -1,3 +1,15 @@
+=== 1.1.0 / 2009-08-10
+
+* 2 Major enhancements
+  * Packaging files that need to be here
+  * Increased the version number
+
+* 1 Minor enhancement
+  * Less C codes
+
+* 1 Bugfix
+  * Increased INTERNET!
+
 === 0.7.2 / 2009-08-05
 
 * 1 major enhancement

data/Manifest.txt

@@ -1,3 +1,4 @@
+.autotest
 History.txt
 Manifest.txt
 README.txt
@@ -5,8 +6,21 @@ Rakefile
 ext/dnssd/dns_sd.h
 ext/dnssd/dnssd.c
 ext/dnssd/dnssd.h
-ext/dnssd/dnssd_service.c
-ext/dnssd/dnssd_structs.c
-ext/dnssd/dnssd_tr.c
+ext/dnssd/errors.c
 ext/dnssd/extconf.rb
+ext/dnssd/flags.c
+ext/dnssd/service.c
 lib/dnssd.rb
+lib/dnssd/flags.rb
+lib/dnssd/reply.rb
+lib/dnssd/service.rb
+lib/dnssd/text_record.rb
+sample/browse.rb
+sample/growl.rb
+sample/highlevel_api.rb
+sample/register.rb
+sample/resolve.rb
+sample/resolve_ichat.rb
+test/test_dnssd_flags.rb
+test/test_dnssd_reply.rb
+test/test_dnssd_text_record.rb

data/Rakefile

@@ -5,6 +5,7 @@ require 'hoe'
 
 Hoe.plugin :minitest
 Hoe.plugin :email
+Hoe.plugin :git
 
 HOE = Hoe.spec 'dnssd' do
   self.rubyforge_name = 'dnssd'
@@ -31,4 +32,6 @@ Rake::ExtensionTask.new 'dnssd', HOE.spec do |ext|
   ext.lib_dir = File.join 'lib', 'dnssd'
 end
 
+task :test => :compile
+
 # vim: syntax=Ruby

data/ext/dnssd/dnssd.c

@@ -1,141 +1,21 @@
-/*
- * == Authors
- * Chad Fowler, Charles Mills, Rich Kilmer
- *
- * == Copyright
- * Copyright (c) 2004 Chad Fowler, Charles Mills, Rich Kilmer
- * Licensed under the same terms as Ruby.
- * This software has absolutely no warranty.
- */
-
 #include "dnssd.h"
-#include <assert.h>
-
-VALUE mDNSSD;
-VALUE eDNSSDError;
-static VALUE eDNSSDUnknownError;
-
-#define DNSSD_ERROR_START (-65556)
-#define DNSSD_ERROR_END   (-65536)
-
-static VALUE dnssd_errors[DNSSD_ERROR_END - DNSSD_ERROR_START];
-
-static void
-dnssd_errors_store(VALUE error, int num) {
-  assert(DNSSD_ERROR_START <= num && num < DNSSD_ERROR_END);
-  dnssd_errors[num - DNSSD_ERROR_START] = error;
-}
 
-void
-dnssd_check_error_code(DNSServiceErrorType e) {
-  int num = (int)e;
-  if (num) {
-    if(DNSSD_ERROR_START <= num && num < DNSSD_ERROR_END) {
-      rb_raise(dnssd_errors[num - DNSSD_ERROR_START],
-          "DNSSD operation failed with error code: %d", num);
-    } else {
-      rb_raise(eDNSSDUnknownError,
-          "DNSSD operation failed with unrecognized error code: %d", num);
-    }
-  }
-}
+void Init_DNSSD_Errors(void);
+void Init_DNSSD_Flags(void);
+void Init_DNSSD_Service(void);
 
 void
-dnssd_instantiation_error(const char *what) {
-  rb_raise(rb_eRuntimeError,
-      "cannot instantiate %s, use DNSSD "
-      "enumerate_domains(), browse(), resolve() or register() instead",
-      what);
-}
-
-/*
- * Document-module: DNSSD
- *
- */
-
-static void
-Init_DNSSD(void) {
-  VALUE error_class;
-  mDNSSD = rb_define_module("DNSSD");
-  eDNSSDError = rb_define_class_under(mDNSSD, "Error", rb_eStandardError);
+Init_dnssd(void) {
+  VALUE mDNSSD = rb_define_module("DNSSD");
 
   /* Specifies all interfaces. */
   rb_define_const(mDNSSD, "InterfaceAny", ULONG2NUM(kDNSServiceInterfaceIndexAny));
+
   /* Specifies local interfaces only. */
   rb_define_const(mDNSSD, "InterfaceLocalOnly", ULONG2NUM(kDNSServiceInterfaceIndexLocalOnly));
 
-  /* errors - these are 2 stepped (create and store) so that rdoc is happy */
-  eDNSSDUnknownError = rb_define_class_under(mDNSSD, "UnknownError", eDNSSDError);
-  dnssd_errors_store(eDNSSDUnknownError, -65537);
-
-  error_class = rb_define_class_under(mDNSSD, "NoSuchNameError", eDNSSDError);
-  dnssd_errors_store(error_class, -65538);
-
-  dnssd_errors_store(rb_eNoMemError, -65539);
-
-  error_class = rb_define_class_under(mDNSSD, "BadParamError", eDNSSDError);
-  dnssd_errors_store(error_class, -65540);
-
-  error_class = rb_define_class_under(mDNSSD, "BadReferenceError", eDNSSDError);
-  dnssd_errors_store(error_class, -65541);
-
-  error_class = rb_define_class_under(mDNSSD, "BadStateError", eDNSSDError);
-  dnssd_errors_store(error_class, -65542);
-
-  error_class = rb_define_class_under(mDNSSD, "BadFlagsError", eDNSSDError);
-  dnssd_errors_store(error_class, -65543);
-
-  error_class = rb_define_class_under(mDNSSD, "UnsupportedError", eDNSSDError);
-  dnssd_errors_store(error_class, -65544);
-
-  error_class = rb_define_class_under(mDNSSD, "NotInitializedError", eDNSSDError);
-  dnssd_errors_store(error_class, -65545);
-
-  error_class = rb_define_class_under(mDNSSD, "AlreadyRegisteredError", eDNSSDError);
-  dnssd_errors_store(error_class, -65547);
-
-  error_class = rb_define_class_under(mDNSSD, "NameConflictError", eDNSSDError);
-  dnssd_errors_store(error_class, -65548);
-
-  error_class = rb_define_class_under(mDNSSD, "InvalidError", eDNSSDError);
-  dnssd_errors_store(error_class, -65549);
-
-  error_class = rb_define_class_under(mDNSSD, "ClientIncompatibleError", eDNSSDError);
-  dnssd_errors_store(error_class, -65551);
-
-  error_class = rb_define_class_under(mDNSSD, "BadInterfaceIndexError", eDNSSDError);
-  dnssd_errors_store(error_class, -65552);
-
-  error_class = rb_define_class_under(mDNSSD, "ReferenceUsedError", eDNSSDError);
-  dnssd_errors_store(error_class, -65553);
-
-  error_class = rb_define_class_under(mDNSSD, "NoSuchRecordError", eDNSSDError);
-  dnssd_errors_store(error_class, -65554);
-
-  error_class = rb_define_class_under(mDNSSD, "NoAuthenticationError", eDNSSDError);
-  dnssd_errors_store(error_class, -65555);
-
-  error_class = rb_define_class_under(mDNSSD, "NoSuchKeyError", eDNSSDError);
-  dnssd_errors_store(error_class, -65556);
-}
-
-/* Document-class: DNSSD::Error
- *
- * Base class of all DNS Service Discovery related errors.
- *
- */
-
-/* defined in other .c files */
-void Init_DNSSD_Service(void);
-void Init_DNSSD_TextRecord(void);
-void Init_DNSSD_Replies(void);
-
-void
-Init_dnssd(void) {
-  /* called when library is required */
-  Init_DNSSD();
+  Init_DNSSD_Errors();
+  Init_DNSSD_Flags();
   Init_DNSSD_Service();
-  Init_DNSSD_TextRecord();
-  Init_DNSSD_Replies();
 }
 

data/ext/dnssd/dnssd.h

@@ -1,8 +1,3 @@
-/*
- * Copyright (c) 2004 Chad Fowler, Charles Mills, Rich Kilmer
- * Licenced under the same terms as Ruby.
- * This software has absolutely no warrenty.
- */
 #ifndef RDNSSD_INCLUDED
 #define RDNSSD_INCLUDED
 
@@ -29,32 +24,10 @@
 #include <sys/if.h>
 #endif
 
-extern VALUE mDNSSD;
 extern VALUE eDNSSDError;
 
 void dnssd_check_error_code(DNSServiceErrorType e);
 void dnssd_instantiation_error(const char *what);
 
-VALUE dnssd_create_fullname(const char *name, const char *regtype, const char *domain, int err_flag);
-VALUE dnssd_split_fullname(VALUE fullname);
-
-/* decodes a buffer, creating a new text record */
-VALUE dnssd_tr_new(long len, const char *buf);
-
-VALUE dnssd_tr_to_encoded_str(VALUE v);
-
-VALUE dnssd_domain_enum_new(VALUE service, DNSServiceFlags flags,
-    uint32_t interface, const char *domain);
-
-VALUE dnssd_browse_new(VALUE service, DNSServiceFlags flags, uint32_t interface,
-    const char *name, const char *regtype, const char *domain);
-
-VALUE dnssd_register_new(VALUE service, DNSServiceFlags flags, const char *name,
-    const char *regtype, const char *domain);
-
-VALUE dnssd_resolve_new(VALUE service, DNSServiceFlags flags, uint32_t interface,
-    const char *fullname, const char *host_target,
-    uint16_t opaqueport, uint16_t txt_len, const char *txt_rec);
-
 #endif /* RDNSSD_INCLUDED */
 

data/ext/dnssd/errors.c

@@ -0,0 +1,105 @@
+#include "dnssd.h"
+#include <assert.h>
+
+VALUE eDNSSDError;
+static VALUE eDNSSDUnknownError;
+
+#define DNSSD_ERROR_START (-65556)
+#define DNSSD_ERROR_END   (-65536)
+
+static VALUE dnssd_errors[DNSSD_ERROR_END - DNSSD_ERROR_START];
+
+static void
+dnssd_errors_store(VALUE error, int num) {
+  assert(DNSSD_ERROR_START <= num && num < DNSSD_ERROR_END);
+  dnssd_errors[num - DNSSD_ERROR_START] = error;
+}
+
+void
+dnssd_check_error_code(DNSServiceErrorType e) {
+  int num = (int)e;
+  if (num) {
+    if(DNSSD_ERROR_START <= num && num < DNSSD_ERROR_END) {
+      rb_raise(dnssd_errors[num - DNSSD_ERROR_START],
+          "DNSSD operation failed with error code: %d", num);
+    } else {
+      rb_raise(eDNSSDUnknownError,
+          "DNSSD operation failed with unrecognized error code: %d", num);
+    }
+  }
+}
+
+void
+dnssd_instantiation_error(const char *what) {
+  rb_raise(rb_eRuntimeError,
+      "cannot instantiate %s, use DNSSD "
+      "enumerate_domains(), browse(), resolve() or register() instead",
+      what);
+}
+
+/* Document-class: DNSSD::Error
+ *
+ * Base class of all DNS Service Discovery related errors.
+ *
+ */
+
+void
+Init_DNSSD_Errors(void) {
+  VALUE error_class;
+  VALUE mDNSSD = rb_define_module("DNSSD");
+
+  eDNSSDError = rb_define_class_under(mDNSSD, "Error", rb_eStandardError);
+
+  eDNSSDUnknownError = rb_define_class_under(mDNSSD, "UnknownError", eDNSSDError);
+  dnssd_errors_store(eDNSSDUnknownError, -65537);
+
+  error_class = rb_define_class_under(mDNSSD, "NoSuchNameError", eDNSSDError);
+  dnssd_errors_store(error_class, -65538);
+
+  dnssd_errors_store(rb_eNoMemError, -65539);
+
+  error_class = rb_define_class_under(mDNSSD, "BadParamError", eDNSSDError);
+  dnssd_errors_store(error_class, -65540);
+
+  error_class = rb_define_class_under(mDNSSD, "BadReferenceError", eDNSSDError);
+  dnssd_errors_store(error_class, -65541);
+
+  error_class = rb_define_class_under(mDNSSD, "BadStateError", eDNSSDError);
+  dnssd_errors_store(error_class, -65542);
+
+  error_class = rb_define_class_under(mDNSSD, "BadFlagsError", eDNSSDError);
+  dnssd_errors_store(error_class, -65543);
+
+  error_class = rb_define_class_under(mDNSSD, "UnsupportedError", eDNSSDError);
+  dnssd_errors_store(error_class, -65544);
+
+  error_class = rb_define_class_under(mDNSSD, "NotInitializedError", eDNSSDError);
+  dnssd_errors_store(error_class, -65545);
+
+  error_class = rb_define_class_under(mDNSSD, "AlreadyRegisteredError", eDNSSDError);
+  dnssd_errors_store(error_class, -65547);
+
+  error_class = rb_define_class_under(mDNSSD, "NameConflictError", eDNSSDError);
+  dnssd_errors_store(error_class, -65548);
+
+  error_class = rb_define_class_under(mDNSSD, "InvalidError", eDNSSDError);
+  dnssd_errors_store(error_class, -65549);
+
+  error_class = rb_define_class_under(mDNSSD, "ClientIncompatibleError", eDNSSDError);
+  dnssd_errors_store(error_class, -65551);
+
+  error_class = rb_define_class_under(mDNSSD, "BadInterfaceIndexError", eDNSSDError);
+  dnssd_errors_store(error_class, -65552);
+
+  error_class = rb_define_class_under(mDNSSD, "ReferenceUsedError", eDNSSDError);
+  dnssd_errors_store(error_class, -65553);
+
+  error_class = rb_define_class_under(mDNSSD, "NoSuchRecordError", eDNSSDError);
+  dnssd_errors_store(error_class, -65554);
+
+  error_class = rb_define_class_under(mDNSSD, "NoAuthenticationError", eDNSSDError);
+  dnssd_errors_store(error_class, -65555);
+
+  error_class = rb_define_class_under(mDNSSD, "NoSuchKeyError", eDNSSDError);
+  dnssd_errors_store(error_class, -65556);
+}

data/ext/dnssd/extconf.rb

@@ -15,16 +15,21 @@ require "mkmf"
 $CFLAGS << " -Wall"
 $CFLAGS << " -DDEBUG" if $DEBUG
 
-unless RUBY_PLATFORM.include? "darwin"
-  have_library( "mdns", "DNSServiceRefSockFD" ) or
-  have_library( "dns_sd", "DNSServiceRefSockFD" ) or
-  abort( "can't find rendezvous library" )
+libraries = {
+  'mdns'   => 'DNSServiceRefSockFD',
+  'dns_sd' => 'DNSServiceRefSockFD',
+  'System' => 'DNSServiceRefSockFD'
+}.sort
+
+dnssd_found = libraries.any? do |library, function|
+  have_library library, function
 end
 
-#have_library( "dns-sd", "DNSServiceRefSockFD" ) or
-# abort( "Can't find rendezvous client library" )
+unless dnssd_found then
+  abort "Couldn't find DNSSD in libraries #{libraries.keys.join ', '}"
+end
 
-have_header("dns_sd.h") or abort("can't find the rendezvous client headers")
+have_header "dns_sd.h" or abort "can't find the rendezvous client headers"
 
 have_header "unistd.h"
 have_header "sys/types.h"

data/ext/dnssd/flags.c

@@ -0,0 +1,124 @@
+#include "dnssd.h"
+
+/* dns sd flags, flag ID's, flag names */
+#define DNSSD_MAX_FLAGS 9
+
+static const DNSServiceFlags dnssd_flag[DNSSD_MAX_FLAGS] = {
+  kDNSServiceFlagsMoreComing,
+
+  kDNSServiceFlagsAdd,
+  kDNSServiceFlagsDefault,
+
+  kDNSServiceFlagsNoAutoRename,
+
+  kDNSServiceFlagsShared,
+  kDNSServiceFlagsUnique,
+
+  kDNSServiceFlagsBrowseDomains,
+  kDNSServiceFlagsRegistrationDomains,
+
+  kDNSServiceFlagsLongLivedQuery
+};
+
+static const char *dnssd_flag_name[DNSSD_MAX_FLAGS] = {
+  "more_coming",
+  "add",
+  "default",
+  "no_auto_rename",
+  "shared",
+  "unique",
+  "browse_domains",
+  "registration_domains",
+  "long_lived_query"
+};
+
+void
+Init_DNSSD_Flags(void) {
+  int i;
+  VALUE flags_hash;
+  VALUE cDNSSDFlags;
+  VALUE mDNSSD = rb_define_module("DNSSD");
+
+  cDNSSDFlags = rb_define_class_under(mDNSSD, "Flags", rb_cObject);
+
+  /* flag constants */
+#if DNSSD_MAX_FLAGS != 9
+#error The code below needs to be updated.
+#endif
+
+  /* MoreComing indicates that at least one more result is queued and will be
+   * delivered following immediately after this one.
+   *
+   * Applications should not update their UI to display browse results when the
+   * MoreComing flag is set, because this would result in a great deal of ugly
+   * flickering on the screen.  Applications should instead wait until
+   * MoreComing is not set, and then update their UI.
+   *
+   * When MoreComing is not set, that doesn't mean there will be no more
+   * answers EVER, just that there are no more answers immediately available
+   * right now at this instant.  If more answers become available in the future
+   * they will be delivered as usual.
+   */
+  rb_define_const(cDNSSDFlags, "MoreComing",
+		  ULONG2NUM(kDNSServiceFlagsMoreComing));
+
+  /* Applies only to enumeration.  An enumeration callback with the
+   * DNSSD::Flags::Add flag NOT set indicates a DNSSD::Flags::Remove, i.e. the
+   * domain is no longer valid.
+   */
+  rb_define_const(cDNSSDFlags, "Add", ULONG2NUM(kDNSServiceFlagsAdd));
+
+  /* Applies only to enumeration and is only valid in conjunction with Add
+   */
+  rb_define_const(cDNSSDFlags, "Default", ULONG2NUM(kDNSServiceFlagsDefault));
+
+  /* Flag for specifying renaming behavior on name conflict when registering
+   * non-shared records.
+   *
+   * By default, name conflicts are automatically handled by renaming the
+   * service.  DNSSD::Flags::NoAutoRename overrides this behavior - with this
+   * flag set, name conflicts will result in a callback.  The NoAutoRename flag
+   * is only valid if a name is explicitly specified when registering a service
+   * (ie the default name is not used.)
+   */
+  rb_define_const(cDNSSDFlags, "NoAutoRename",
+		  ULONG2NUM(kDNSServiceFlagsNoAutoRename));
+
+  /* Flag for registering individual records on a connected DNSServiceRef.
+   *
+   * DNSSD::Flags::Shared indicates that there may be multiple records with
+   * this name on the network (e.g. PTR records).  DNSSD::Flags::Unique
+   * indicates that the record's name is to be unique on the network (e.g. SRV
+   * records).  (DNSSD::Flags::Shared and DNSSD::Flags::Unique are currently
+   * not used by the Ruby API.)
+   */
+  rb_define_const(cDNSSDFlags, "Shared", ULONG2NUM(kDNSServiceFlagsShared));
+  rb_define_const(cDNSSDFlags, "Unique", ULONG2NUM(kDNSServiceFlagsUnique));
+
+  /* DNSSD::Flags::BrowseDomains enumerates domains recommended for browsing
+   */
+  rb_define_const(cDNSSDFlags, "BrowseDomains",
+		  ULONG2NUM(kDNSServiceFlagsBrowseDomains));
+
+  /* DNSSD::Flags::RegistrationDomains enumerates domains recommended for
+   * registration.
+   */
+
+  rb_define_const(cDNSSDFlags, "RegistrationDomains",
+		  ULONG2NUM(kDNSServiceFlagsRegistrationDomains));
+
+  /* Flag for creating a long-lived unicast query for the DNSDS.query_record()
+   * (currently not part of the Ruby API). */
+  rb_define_const(cDNSSDFlags, "LongLivedQuery",
+		  ULONG2NUM(kDNSServiceFlagsLongLivedQuery));
+
+  flags_hash = rb_hash_new();
+
+  for (i = 0; i < DNSSD_MAX_FLAGS; i++) {
+    rb_hash_aset(flags_hash, rb_str_new2(dnssd_flag_name[i]),
+		 ULONG2NUM(dnssd_flag[i]));
+  }
+
+  rb_define_const(cDNSSDFlags, "FLAGS", flags_hash);
+}
+